InfluxDB 2.1 (#3367)

* base changes for influxdb 2.1

* remove duplicates in draft

* draft categories

* add categories

* Document wildcards in SHOW MEASUREMENTS ON queries (#3273)

* InfluxQL: document wildcards in SHOW MEASUREMENTS ON queries

This applies to InfluxDB 2.1.

See #3201

* latest notes

* Update `influxd --store` values (#3272)

* Use Unix ~ alias
* Add sqlite path to file layout doc
* add sqlite to filesystem diagrams

* draft 2.1 release notes +questions

* revert to check RNs changes in separately

* latest release notes

* Restructure installation docs for separate CLI package (#3280)

* influxdb and cli install revamp

* reorganized CLI install instructions

* remove unnecessary short-code parameters

* updated docs to address PR feedback

* Apply suggestions from code review

Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Apply suggestions from code review

* update linux install instructions

Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* release note updates

* updates

* add support for annotations in OSS 2.1 (#3286)

* Document support for bearer auth sytax (#3297)

* 2.1 oss notebooks (#3281)

* Move notebooks to OSS (addresses #2951 )

* Update content/influxdb/v2.1/notebooks/clean-data.md

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

* Update content/influxdb/v2.1/notebooks/create-notebook.md

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

* Update content/influxdb/v2.1/notebooks/manage-notebooks.md

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

* Update content/influxdb/v2.1/notebooks/overview.md

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

* Update content/influxdb/v2.1/notebooks/_index.md

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

* Update content/influxdb/v2.1/notebooks/troubleshoot-notebooks.md

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

* Update content/influxdb/v2.1/notebooks/clean-data.md

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

* Update content/influxdb/v2.1/notebooks/clean-data.md

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

* Update content/influxdb/v2.1/notebooks/clean-data.md

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

* Update content/influxdb/v2.1/notebooks/create-notebook.md

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

* Update content/influxdb/v2.1/notebooks/create-notebook.md

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

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update content/influxdb/v2.1/notebooks/overview.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update content/influxdb/v2.1/notebooks/overview.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update content/influxdb/v2.1/notebooks/overview.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update content/influxdb/v2.1/notebooks/overview.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update content/influxdb/v2.1/notebooks/overview.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update content/influxdb/v2.1/notebooks/overview.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update content/influxdb/v2.1/notebooks/overview.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Add PR feedback

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

* Fix link in bearer auth sytax doc (#3298)

* Updated CLI docs content and added version metadata (#3285)

* added metadata styles and data to cli docs

* added missing ui-disabled influxd config flag

* added updated versions to influx cli metadata

* added metadata to all cloud influx cli docs

* updated influx ping in cloud to have oss only tag

* Update influxd documentation for 2.1 (#3302)

* update and dynamically generate links to influxd flags (#3288)

* remove 2.1 config options from 2.0

* New influxd commands (#3291)

* added basic influxd recovery commands

* added influxd recover commands, WIP for other influxd inspect commands

* updated all influxd inspect commands

* Apply suggestions from code review

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* updated influxd docs to address PR feedback

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Add static legend to band and graph visualizations (#3315)

* update band vis to include static legend

* upd graph and graph-single-stat w static legend

* update 2.1 links

* update to latest Flux links

* fix Flux links

* Influxdb 2.1 release notes (#3279)

* draft release notes

* latest RN changes

* test

* revert

* for review purposes

* incorporate changes from new changelog

* add note about new metadata included in CLI docs

* edit

* more edits

* add overview features list

* tweak verbiage about Telegraf support

* Update content/influxdb/v2.1/reference/release-notes/influxdb.md

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

* Update content/influxdb/v2.1/reference/release-notes/influxdb.md

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

* Update content/influxdb/v2.1/reference/release-notes/influxdb.md

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

* Update content/influxdb/v2.1/reference/release-notes/influxdb.md

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

* Update content/influxdb/v2.1/reference/release-notes/influxdb.md

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

* Update content/influxdb/v2.1/reference/release-notes/influxdb.md

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

* Update content/influxdb/v2.1/reference/release-notes/influxdb.md

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

* Update content/influxdb/v2.1/reference/release-notes/influxdb.md

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

* Update content/influxdb/v2.1/reference/release-notes/influxdb.md

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

* Update content/influxdb/v2.1/reference/release-notes/influxdb.md

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

* Update content/influxdb/v2.1/reference/release-notes/influxdb.md

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

* add link

* add edits from Scott, Dan, and Will

* edits from dan

* highlight and distinguish CLI separation changes

* add links to new API endpoints

* formatting upd

* edits for secrets

* mv Flux location support after rsv merge conflicts

* edits from Tim

* update influxql link

* rmv SLQ metastore link

* minor updates to 2.1 release notes

* prep

* Update content/influxdb/v2.1/reference/release-notes/influxdb.md

Co-authored-by: Greg <2653109+glinton@users.noreply.github.com>

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Co-authored-by: Scott Anderson <scott@influxdata.com>
Co-authored-by: Greg <2653109+glinton@users.noreply.github.com>

* add new Telegraf plugins to release notes

* edit from Will

* 2.1 upgrade and downgrade instructions (#3332)

* influxd downgrade command, add upgrade instructions, closes #3331

* Apply suggestions from code review

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Daniel Moran <danxmoran@gmail.com>

* udpated downgrade docs to address PR feedback

* remove references to localhost:1313

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
Co-authored-by: Daniel Moran <danxmoran@gmail.com>

* updated flux version in release notes, added other new items, closes #3338 (#3344)

* Chore/update oss api (#3341)

* Standardize the term "key-value" (#3283)

* s|key/value|key-value
* Use en dash in prefix to open compound "time series"

* CLI 2.2 (#3269)

* add -b shorthand to influx delete

* add cli 2.2 release notes

* add example for all-access token

* edits

* updates to influx auth create

* edits for operator token

* remove inaccurate env var

* Update influx-cli.md

* Update influx-cli.md

* make capitalization consistent with other docs

* make headers parallel

* Update content/influxdb/cloud/reference/release-notes/influx-cli.md

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

* Update content/influxdb/cloud/reference/release-notes/influx-cli.md

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

* Update content/influxdb/cloud/reference/release-notes/influx-cli.md

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

* edits from Scott and Dan

* Update content/influxdb/v2.0/reference/cli/influx/auth/create.md

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

* Update content/influxdb/v2.0/reference/cli/influx/auth/create.md

Co-authored-by: Daniel Moran <danxmoran@gmail.com>

* Update content/influxdb/v2.0/reference/cli/influx/auth/create.md

Co-authored-by: Daniel Moran <danxmoran@gmail.com>

* edits to CLI

* add oss-only shortcode and fix formatting

* format updates

* fix links

* add oss-only inline

* fix list

* Update content/influxdb/v2.0/security/tokens/create-token.md

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

* Update content/influxdb/v2.0/security/tokens/create-token.md

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

* Update content/influxdb/v2.0/security/tokens/create-token.md

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

* edits from Dan

* emphasize recommendation

* edit from Dan re limits and page size

* edit f Sam

* update release date

* remove vague description

* Update content/influxdb/cloud/reference/release-notes/influx-cli.md

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

* Update content/influxdb/v2.0/reference/cli/influx/auth/create.md

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

* Update content/influxdb/v2.0/reference/cli/influx/auth/create.md

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

* Update content/influxdb/cloud/reference/release-notes/influx-cli.md

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

* Update content/influxdb/cloud/reference/release-notes/influx-cli.md

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

* edits from Scott

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

* add cloud updates in Sept (#3210)

* Fix numbering in AWS install doc (#3293)

Closes #3292

* Document new API Invocable Scripts feature (was named-functions) (#3282)

* feat: add api-guides/guides and guides/api-invocable-scripts for the API-invocable scripts (managed functions) feature (##2547, #2233).

* feat: document API-invocable scripts. Add example for creating and invoking a script with POST. Unable to make GET work with query parameters.

* feat: moved API-invocable scripts under api-guide. Remove guides directory. Add docs for list and find. Add example for list. Add shortcuts and glossary links. Verified with team-compute that GET /invoke and python are not supported yet.

* feat: rename example function for simplicity since there's no GET for now.

* feat: add find_and_update example (#2547).

* feat: add update example. Clarify, expand invoke example. Add links. (#2547)

* Update content/influxdb/cloud/api-guide/api-invocable-scripts/_index.md

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

* fix: remove accidental commit of generated redoc-static.html

* feat: manual update to cloud swagger. Merges meta, auth, tags, and x-tagGroups from src/cloud.yml to aggregate contracts/ref/cloud.yml.

* fix: replace /functions with /scripts

* feat: get swaggers from contracts/ref. Still requires copy-paste of info, tags, and auth from contracts/cloud.yml and contracts/oss.yml

* feat: invocable scripts (#2547)

* Update content/influxdb/cloud/api-guide/api-invocable-scripts/_index.md

Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>

* feat: new section for params (#2547).

* fix: swagger server url (#2547)

* Update content/influxdb/cloud/api-guide/api-invocable-scripts/_index.md

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

* feat: remove jq and function where there's no clear need.

Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>

* fix: add Invocable Scripts tag description. (#3296)

* Fix api invocable (#3299)

* fix: scripts api path.

* fix: bad comma

* Fix api invocable (#3306)

* fix: scripts api path.

* fix: bad comma

* feat: add invocable scripts example for sending multiple parameter values.

* fix: endpoint text. (#3308)

* Fix api invocable (#3310)

* fix: measurement -> point

* fix: cloud API ref. Remove private paths. Patch description and orgID params into ScriptCreateRequest.

* updated token naming and other typos, closes influxdata/DAR#244 (#3309)

* Flux 0.136 (#3311)

* Flux 0.136.0 release notes

* Update pagerduty package for flux 0.136.0 (#3303)

* Add Flux ServiceNow package (#3304)

* added Flux servicenow package

* Apply suggestions from code review

* Enterprise dar updates (#3313)

* removed references to web server in enteprise cluster docs, closes influxdata/DAR#245

* updated enterprise upgrade instructions, closes influxdata/DAR#243

* Apply suggestions from code review

Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>

Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>

* fix: mjs example path (#3305) (#3316)

* 3240 fix nodejs alias (#3317)

* fix: mjs example path (#3305)

* fix: add alias to node.js client library (#3240)

* Edit description for amd_rocm_smi Telegraf plugin (#3186)

* Edit description for amd_rocm_smi Telegraf plugin

Edit name and description for amd_rocm_smi Telegraf plugin. 

Not sure if this is the only location that it needs to be udpated.

* cpl minor updates

Co-authored-by: Kelly <kelly@influxdata.com>

* remove influxql support from v2 api, closes influxdata/DAR#246 (#3326)

* Telegraf 1.20.3 (#3328)

* Telegraf 1.20.3

* Update content/telegraf/v1.20/about_the_project/release-notes-changelog.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update content/telegraf/v1.20/about_the_project/release-notes-changelog.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update content/telegraf/v1.20/about_the_project/release-notes-changelog.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Address PR feedback

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* docs: update telegraf configuration.md (#3300)

* docs: update telegraf configuration.md

* add note about rate limits

* fix: correct debian/ubuntu install instructions (#3312)

* fix: correct debian/ubuntu install instructions

This consolidates the Debian and Ubutnu install instructions into one
section. The install instructions can be the same for both as they use
the same package manager (i.e. apt).

This removes the use of the now deprecated pipe to apt-key.

This removes references to starting the service, as the service starts
on install and does not require an extra step. Also all supported
operating systems are using systemd at this point so no need to call
that out seperatly.

Removes an extra 'sudo' in deb instructions.

* missing word

* added flux 0.137.0 release notes, added vertica sql support docs (#3318)

* Update _index.md (#3195)

broken link for external plugin repo

* Addresses #3284 (#3334)

* Updates to Flux `to()` (#3260)

Closes https://github.com/influxdata/DAR/issues/236.
Closes #3258.

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

* Fix shim and other link (#3336)

* Update Kapacitor security docs (#3325)

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Include TLS setup in Enterprise post-install steps  (#3271)

- Rename TLS guide file.
- Use term "TLS" in title and introduction of TLS guide.

Closes #3270.

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Flux 0.138.0 and 0.139.0 (#3335)

* added release notes for flux 0.138 and 0.139 and related updates

* updated spec with related implementation issue

* Apply suggestions from code review

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* updated to address PR feedback, added related links to int, uint, and bitwise docs

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* hotfix load data link

* add aliases and fix load data link in oss

* API Ref docs processing (#3337)

* chore: API Reference Docs custom processing. Pulls contracts/ref files and applies custom content (tags, x-tagGroups, securitySchemes, info) before writing results to cloud/ref.yml and v2.0/ref.yml.
Rename source files from swagger.yml to ref.yml to avoid confusion and in case we need to bundle additional specs in the future.
Add an OpenAPI CLI docs-plugin with content and decorators.

* chore: update api-docs/README.md

* fix: add strip-version-prefix to remove /api/v2 added incorrectly to some paths during contract generation - also fixed in openapi repo so future contracts won't need this decorator. Fix server urls. Cleanup.

* chore: update cloud contract.

* chore: update oss API contract.

* Apply suggestions from code review

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Co-authored-by: Daniel Moran <danxmoran@gmail.com>
Co-authored-by: Samantha Wang <32681364+sjwang90@users.noreply.github.com>
Co-authored-by: Kelly <kelly@influxdata.com>
Co-authored-by: noramullen1 <42354779+noramullen1@users.noreply.github.com>
Co-authored-by: Joshua Powers <powersj@influxdata.com>
Co-authored-by: bgilmore-iot <85192039+bgilmore-iot@users.noreply.github.com>

* edit from Tim: update v2.0 to v2.1 in API section

* fix 2.1 links

* Fix/api ref 2.1 (#3363)

* fix: cloud-specific v1compat auth examples.

* fix: openapi. Disabled securityScheme replacement. Cleaned up placeholders. Added links.

* fix: update API auth descriptions. add API ref v2.1. Update links in openapi content.

* fix: updates URLs to v2.1 in API ref docs

* add verify-tsm to 2.1 release notes

* Clockface updates for 2.1 and Cloud (#3364)

* versioned old icomoon font

* updated all existing icons with versioned style

* Revert "updated all existing icons with versioned style"

This reverts commit 79b6cdf539.

* versioned icon shortcode

* update icons and new styles for clockface v3

* updated nav-icon shortcode and styles

* updated account nav icon styles

* misc updates

* general style updates

* updated oss versions on the homepage

* fixed tick card colors on homepage

Co-authored-by: Kelly <kelly@influxdata.com>
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
Co-authored-by: noramullen1 <42354779+noramullen1@users.noreply.github.com>
Co-authored-by: Greg <2653109+glinton@users.noreply.github.com>
Co-authored-by: Daniel Moran <danxmoran@gmail.com>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
Co-authored-by: Samantha Wang <32681364+sjwang90@users.noreply.github.com>
Co-authored-by: Joshua Powers <powersj@influxdata.com>
Co-authored-by: bgilmore-iot <85192039+bgilmore-iot@users.noreply.github.com>
pull/3377/head
Scott Anderson 2021-11-08 10:48:11 -07:00 committed by GitHub
parent c846398a76
commit 04b47d149b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
630 changed files with 62398 additions and 9724 deletions

View File

@ -94,6 +94,8 @@ prepend: # Prepend markdown content to an article (especially powerful with casc
append: # Append markdown content to an article (especially powerful with cascade) append: # Append markdown content to an article (especially powerful with cascade)
block: # (Optional) Wrap content in a block style (note, warn, cloud) block: # (Optional) Wrap content in a block style (note, warn, cloud)
content: # Content to append to article content: # Content to append to article
metadata: [] # List of metadata messages to include under the page h1
updated_in: # Product and version the referenced feature was updated in (displayed as a unique metadata)
``` ```
### Title usage ### Title usage
@ -818,9 +820,11 @@ The following table shows which children types use which frontmatter properties:
### Inline icons ### Inline icons
The `icon` shortcode allows you to inject icons in paragraph text. The `icon` shortcode allows you to inject icons in paragraph text.
It's meant to clarify references to specific elements in the InfluxDB user interface. It's meant to clarify references to specific elements in the InfluxDB user interface.
This shortcode supports clockface (the UI) v2 and v3.
Specify the version to use as the 2nd argument. The default version is `v3`.
``` ```
{{< icon "icon-name" >}} {{< icon "icon-name" "v2" >}}
``` ```
Below is a list of available icons (some are aliases): Below is a list of available icons (some are aliases):
@ -890,9 +894,11 @@ Below is a list of available icons (some are aliases):
### InfluxDB UI left navigation icons ### InfluxDB UI left navigation icons
In many cases, documentation references an item in the left nav of the InfluxDB UI. In many cases, documentation references an item in the left nav of the InfluxDB UI.
Provide a visual example of the navigation item using the `nav-icon` shortcode. Provide a visual example of the navigation item using the `nav-icon` shortcode.
This shortcode supports clockface (the UI) v2 and v3.
Specify the version to use as the 2nd argument. The default version is `v3`.
``` ```
{{< nav-icon "tasks" >}} {{< nav-icon "tasks" "v2" >}}
``` ```
The following case insensitive values are supported: The following case insensitive values are supported:
@ -1048,6 +1054,14 @@ This is necessary to get the first sentence/paragraph to render correctly.
{{% /cloud-only %}} {{% /cloud-only %}}
``` ```
#### All-Caps
Clockface v3 introduces many buttons with text formatted as all-caps.
Use the `{{< caps >}}` shortcode to format text to match those buttons.
```md
Click {{< caps >}}Add Data{{< /caps >}}
```
### Reference content ### Reference content
The InfluxDB documentation is "task-based," meaning content primarily focuses on The InfluxDB documentation is "task-based," meaning content primarily focuses on
what a user is **doing**, not what they are **using**. what a user is **doing**, not what they are **using**.

View File

@ -5886,31 +5886,37 @@ components:
type: object type: object
securitySchemes: securitySchemes:
BasicAuthentication: BasicAuthentication:
type: http
scheme: basic
description: > description: >
### Basic authentication scheme ### Basic authentication scheme
Use HTTP Basic Auth with clients that support the InfluxDB 1.x Use the HTTP Basic authentication scheme with clients that support the
convention of username and password (that don't support the InfluxDB 1.x convention of username and password (that don't support the
`Authorization: Token` scheme): `Authorization: Token` scheme):
- **username**: InfluxDB Cloud username - **username**: InfluxDB Cloud username
- **password**: InfluxDB Cloud API token - **password**: InfluxDB Cloud API token
### Example #### Example
`curl --get "https://europe-west1-1.gcp.cloud2.influxdata.com/query" `curl --get "https://europe-west1-1.gcp.cloud2.influxdata.com/query"
--user "YOUR_USERNAME":"YOUR_TOKEN_OR_PASSWORD"` --user "exampleuser@influxdata.com":"INFLUX_API_TOKEN"`
Replace the following:
- *`exampleuser@influxdata.com`*: the email address that you signed up
with
- *`INFLUX_API_TOKEN`*: your [InfluxDB API
token](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#token)
For more information and examples, see how to [authenticate with a For more information and examples, see how to [authenticate with a
username and password username and
scheme](https://docs.influxdata.com/influxdb/cloud/reference/api/influxdb-1x/). password](https://docs.influxdata.com/influxdb/cloud/reference/api/influxdb-1x/).
scheme: basic
type: http
QuerystringAuthentication: QuerystringAuthentication:
type: apiKey
in: query
name: u=&p=
description: > description: >
### Querystring authentication scheme ### Querystring authentication scheme
@ -5926,20 +5932,30 @@ components:
- **password**: InfluxDB Cloud API token - **password**: InfluxDB Cloud API token
### Example #### Example
`curl --get "https://europe-west1-1.gcp.cloud2.influxdata.com/query" `curl --get "https://europe-west1-1.gcp.cloud2.influxdata.com/query"
--data-urlencode "u=YOUR_USERNAME" --data-urlencode "u=exampleuser@influxdata.com"
--data-urlencode "p=YOUR_TOKEN_OR_PASSWORD"` --data-urlencode "p=INFLUX_API_TOKEN"`
Replace the following:
- *`exampleuser@influxdata.com`*: the email address that you signed up
with
- *`INFLUX_API_TOKEN`*: your [InfluxDB API
token](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#token)
For more information and examples, see how to [authenticate with a For more information and examples, see how to [authenticate with a
username and password username and password
scheme](https://docs.influxdata.com/influxdb/cloud/reference/api/influxdb-1x/). scheme](https://docs.influxdata.com/influxdb/cloud/reference/api/influxdb-1x/).
in: query
name: u=&p=
type: apiKey
TokenAuthentication: TokenAuthentication:
type: http bearerFormat: InfluxDB token string
scheme: token
bearerFormat: InfluxDB Token String
description: > description: >
### Token authentication scheme ### Token authentication scheme
@ -5949,20 +5965,27 @@ components:
within the organization. within the organization.
Include your API token in an `Authorization: Token YOUR_API_TOKEN` HTTP Include your API token in an `Authorization: Token INFLUX_TOKEN` HTTP
header with each request. header with each request.
### Example #### Example
`curl https://us-east-1-1.aws.cloud2.influxdata.com/ `curl https://us-east-1-1.aws.cloud2.influxdata.com/
--header "Authorization: Token YOUR_API_TOKEN"` --header "Authorization: Token INFLUX_API_TOKEN"`
Replace *`INFLUX_API_TOKEN`* with your [InfluxDB API
token](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#token).
For more information and examples, see the following: For more information and examples, see the following:
- [`/authorizations`](#tag/Authorizations) endpoint.
- [Use tokens in API requests](https://docs.influxdata.com/influxdb/cloud/api-guide/api_intro/#authentication). - [Use tokens in API requests](https://docs.influxdata.com/influxdb/cloud/api-guide/api_intro/#authentication).
- [Manage API tokens](https://docs.influxdata.com/influxdb/cloud/security/tokens). - [Manage API tokens](https://docs.influxdata.com/influxdb/cloud/security/tokens).
- [`/authorizations`](#tag/Authorizations) endpoint. - [Assign a token to a specific user](https://docs.influxdata.com/influxdb/cloud/security/tokens/create-token).
scheme: token
type: http
info: info:
title: Influx Cloud API Service title: Influx Cloud API Service
description: > description: >
@ -12326,8 +12349,7 @@ security:
servers: servers:
- url: / - url: /
tags: tags:
- name: Authentication - description: >
description: >
Use one of the following schemes to authenticate to the InfluxDB API: Use one of the following schemes to authenticate to the InfluxDB API:
- [Token authentication](#section/Authentication/TokenAuthentication) - [Token authentication](#section/Authentication/TokenAuthentication)
@ -12338,12 +12360,20 @@ tags:
authentication](#section/Authentication/QuerystringAuthentication) authentication](#section/Authentication/QuerystringAuthentication)
<!-- ReDoc-Inject: <security-definitions> --> <!-- ReDoc-Inject: <security-definitions> -->
name: Authentication
x-traitTag: true x-traitTag: true
- name: Authorizations - description: >
description: >
Create and manage API tokens. An **authorization** associates a list of Create and manage API tokens. An **authorization** associates a list of
permissions to an **organization** and provides a token for API access. To permissions to an **organization** and provides a token for API access.
assign a token to a specific user, scope the authorization to the user ID. Optionally, you can restrict an authorization and its token to a specific
user.
For more information and examples, see the following:
- [Use tokens in API requests](https://docs.influxdata.com/influxdb/cloud/api-guide/api_intro/#authentication).
- [Manage API tokens](https://docs.influxdata.com/influxdb/cloud/security/tokens).
- [Assign a token to a specific user](https://docs.influxdata.com/influxdb/cloud/security/tokens/create-token).
name: Authorizations
- Bucket Schemas - Bucket Schemas
- Buckets - Buckets
- Cells - Cells
@ -12352,45 +12382,17 @@ tags:
- DBRPs - DBRPs
- Delete - Delete
- DemoDataBuckets - DemoDataBuckets
- name: Invocable Scripts - Invocable Scripts
description: >
Manage and execute scripts as API endpoints in InfluxDB.
An API Invocable Script assigns your custom Flux script to a new InfluxDB
API endpoint for your organization.
Invocable scripts let you execute your script as an HTTP request to the
endpoint.
Invocable scripts accept parameters. Add parameter references in your
script as `params.myparameter`.
When you `invoke` your script, you send parameters as key-value pairs in
the `params` object.
InfluxDB executes your script with the key-value pairs as arguments and
returns the result.
For more information and examples, see [Invoke custom
scripts](https://docs.influxdata.com/influxdb/cloud/api-guide/api-invocable-scripts).
- Labels - Labels
- Limits - Limits
- NotificationEndpoints - NotificationEndpoints
- NotificationRules - NotificationRules
- Organizations - Organizations
- Ping - Ping
- name: Query - description: |
description: |
Retrieve data, analyze queries, and get query suggestions. Retrieve data, analyze queries, and get query suggestions.
- name: Quick start name: Query
description: Some quickness - description: >
x-traitTag: true
- name: Quick start
x-traitTag: true
description: >
See the [**API Quick See the [**API Quick
Start**](https://docs.influxdata.com/influxdb/cloud/api-guide/api_intro/) Start**](https://docs.influxdata.com/influxdb/cloud/api-guide/api_intro/)
to get up and running authenticating with tokens, writing to buckets, and to get up and running authenticating with tokens, writing to buckets, and
@ -12401,10 +12403,10 @@ tags:
libraries**](https://docs.influxdata.com/influxdb/cloud/api-guide/client-libraries/) libraries**](https://docs.influxdata.com/influxdb/cloud/api-guide/client-libraries/)
are available for popular languages and ready to import into your are available for popular languages and ready to import into your
application. application.
- Resources name: Quick start
- name: Response codes
x-traitTag: true x-traitTag: true
description: > - Resources
- description: >
The InfluxDB API uses standard HTTP status codes for success and failure The InfluxDB API uses standard HTTP status codes for success and failure
responses. responses.
@ -12457,6 +12459,8 @@ tags:
| `503` | Service unavailable | Server is temporarily | `503` | Service unavailable | Server is temporarily
unavailable to process the request. The `Retry-After` header describes unavailable to process the request. The `Retry-After` header describes
when to try the request again. | when to try the request again. |
name: Response codes
x-traitTag: true
- Routes - Routes
- Rules - Rules
- Secrets - Secrets
@ -12471,9 +12475,9 @@ tags:
- Users - Users
- Variables - Variables
- Views - Views
- name: Write - description: |
description: |
Write time series data to buckets. Write time series data to buckets.
name: Write
x-tagGroups: x-tagGroups:
- name: Overview - name: Overview
tags: tags:

View File

@ -1,6 +1,3 @@
- name: Quick start
description: Some quickness
x-traitTag: true
- name: Authentication - name: Authentication
description: | description: |
Use one of the following schemes to authenticate to the InfluxDB API: Use one of the following schemes to authenticate to the InfluxDB API:
@ -18,7 +15,7 @@
Invocable scripts accept parameters. Add parameter references in your script as `params.myparameter`. Invocable scripts accept parameters. Add parameter references in your script as `params.myparameter`.
When you `invoke` your script, you send parameters as key-value pairs in the `params` object. When you `invoke` your script, you send parameters as key-value pairs in the `params` object.
InfluxDB executes your script with the key-value pairs as arguments and returns the result. Then, InfluxDB executes your script with the key-value pairs as arguments, and returns the result.
For more information and examples, see [Invoke custom scripts](https://docs.influxdata.com/influxdb/cloud/api-guide/api-invocable-scripts). For more information and examples, see [Invoke custom scripts](https://docs.influxdata.com/influxdb/cloud/api-guide/api-invocable-scripts).
- name: Quick start - name: Quick start

View File

@ -0,0 +1,3 @@
title: Influx OSS API Service
description: |
The InfluxDB v2 API provides a programmatic interface for all interactions with InfluxDB. Access the InfluxDB API using the `/api/v2/` endpoint.

View File

@ -0,0 +1,58 @@
TokenAuthentication:
type: http
scheme: token
bearerFormat: InfluxDB Token String
description: |
### Token authentication scheme
InfluxDB API tokens ensure secure interaction between users and data. A token belongs to an organization and identifies InfluxDB permissions within the organization.
Include your API token in an `Authentication: Token YOUR_API_TOKEN` HTTP header with each request.
### Example
`curl http://localhost:8086/ping
--header "Authentication: Token YOUR_API_TOKEN"`
For more information and examples, see the following:
- [Use tokens in API requests](https://docs.influxdata.com/influxdb/v2.1/api-guide/api_intro/#authentication).
- [Manage API tokens](https://docs.influxdata.com/influxdb/v2.1/security/tokens).
- [`/authorizations`](#tag/Authorizations) endpoint.
BasicAuthentication:
type: http
scheme: basic
description: |
### Basic authentication scheme
Use HTTP Basic Auth with clients that support the InfluxDB 1.x convention of username and password (that don't support the `Authorization: Token` scheme).
Username and password schemes require the following credentials:
- **username**: 1.x username (this is separate from the UI login username)
- **password**: 1.x password or InfluxDB API token
### Example
`curl --get "http://localhost:8086/query"
--user "YOUR_1.x_USERNAME":"YOUR_TOKEN_OR_PASSWORD"`
For more information and examples, see how to [authenticate with a username and password scheme](https://docs.influxdata.com/influxdb/v2.1/reference/api/influxdb-1x/)
QuerystringAuthentication:
type: apiKey
in: query
name: u=&p=
description: |
### Querystring authentication scheme
Use InfluxDB 1.x API parameters to provide credentials through the query string.
Username and password schemes require the following credentials:
- **username**: 1.x username (this is separate from the UI login username)
- **password**: 1.x password or InfluxDB API token
### Example
`curl --get "http://localhost:8086/query"
--data-urlencode "u=YOUR_1.x_USERNAME"
--data-urlencode "p=YOUR_TOKEN_OR_PASSWORD"`
For more information and examples, see how to [authenticate with a username and password scheme](https://docs.influxdata.com/influxdb/v2.1/reference/api/influxdb-1x/)

View File

@ -0,0 +1,28 @@
- name: Overview
tags:
- Quick start
- Authentication
- Response codes
- name: Data I/O endpoints
tags:
- Write
- Query
- name: Resource endpoints
tags:
- Buckets
- Dashboards
- Tasks
- Resources
- name: Security and access endpoints
tags:
- Authorizations
- Organizations
- Users
- name: System information endpoints
tags:
- Health
- Ping
- Ready
- Routes
- name: All endpoints
tags: []

View File

@ -0,0 +1,43 @@
- name: Authentication
description: |
Use one of the following schemes to authenticate to the InfluxDB API:
- [Token authentication](#section/Authentication/TokenAuthentication)
- [Basic authentication](#section/Authentication/BasicAuthentication)
- [Querystring authentication](#section/Authentication/QuerystringAuthentication)
<!-- ReDoc-Inject: <security-definitions> -->
x-traitTag: true
- name: Quick start
x-traitTag: true
description: |
See the [**API Quick Start**](https://docs.influxdata.com/influxdb/v2.1/api-guide/api_intro/) to get up and running authenticating with tokens, writing to buckets, and querying data.
[**InfluxDB API client libraries**](https://docs.influxdata.com/influxdb/v2.1/api-guide/client-libraries/) are available for popular languages and ready to import into your application.
- name: Response codes
x-traitTag: true
description: |
The InfluxDB API uses standard HTTP status codes for success and failure responses.
The response body may include additional details. For details about a specific operation's response, see **Responses** and **Response Samples** for that operation.
API operations may return the following HTTP status codes:
| &nbsp;Code&nbsp; | Status | Description |
|:-----------:|:------------------------ |:--------------------- |
| `200` | Success | |
| `204` | No content | For a `POST` request, `204` indicates that InfluxDB accepted the request and request data is valid. Asynchronous operations, such as `write`, might not have completed yet. |
| `400` | Bad request | `Authorization` header is missing or malformed or the API token does not have permission for the operation. |
| `401` | Unauthorized | May indicate one of the following: <li>`Authorization: Token` header is missing or malformed</li><li>API token value is missing from the header</li><li>API token does not have permission. For more information about token types and permissions, see [Manage API tokens](https://docs.influxdata.com/influxdb/v2.1/security/tokens/)</li> |
| `404` | Not found | Requested resource was not found. `message` in the response body provides details about the requested resource. |
| `413` | Request entity too large | Request payload exceeds the size limit. |
| `422` | Unprocessible entity | Request data is invalid. `code` and `message` in the response body provide details about the problem. |
| `429` | Too many requests | API token is temporarily over the request quota. The `Retry-After` header describes when to try the request again. |
| `500` | Internal server error | |
| `503` | Service unavailable | Server is temporarily unavailable to process the request. The `Retry-After` header describes when to try the request again. |
- name: Query
description: |
Retrieve data, analyze queries, and get query suggestions.
- name: Write
description: |
Write time series data to buckets.
- name: Authorizations
description: |
Create and manage API tokens. An **authorization** associates a list of permissions to an **organization** and provides a token for API access. To assign a token to a specific user, scope the authorization to the user ID.

View File

@ -46,8 +46,6 @@ module.exports = {
'docs/remove-private-paths': 'error', 'docs/remove-private-paths': 'error',
'docs/strip-version-prefix': 'error', 'docs/strip-version-prefix': 'error',
'docs/set-info': 'error', 'docs/set-info': 'error',
'docs/set-security-schemes': 'error',
'docs/set-tags': 'error',
'docs/set-tag-groups': 'error', 'docs/set-tag-groups': 'error',
}, },
}, },

File diff suppressed because it is too large Load Diff

13128
api-docs/v2.1/ref.yml Normal file

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,329 @@
# this is a manually maintained file for these old routes until oats#15 is resolved
openapi: "3.0.0"
info:
title: Influx API Service (V1 compatible endpoints)
version: 0.1.0
servers:
- url: /
description: V1 compatible api endpoints.
paths:
/write:
post: # technically this functions with other methods as well
operationId: PostWriteV1
tags:
- Write
summary: Write time series data into InfluxDB in a V1 compatible format
requestBody:
description: Line protocol body
required: true
content:
text/plain:
schema:
type: string
parameters:
- $ref: "#/components/parameters/TraceSpan"
- $ref: "#/components/parameters/AuthUserV1"
- $ref: "#/components/parameters/AuthPassV1"
- in: query
name: db
schema:
type: string
required: true
description: The bucket to write to. If the specified bucket does not exist, a bucket is created with a default 3 day retention policy.
- in: query
name: rp
schema:
type: string
description: The retention policy name.
- in: query
name: precision
schema:
type: string
description: Write precision.
- in: header
name: Content-Encoding
description: When present, its value indicates to the database that compression is applied to the line-protocol body.
schema:
type: string
description: Specifies that the line protocol in the body is encoded with gzip or not encoded with identity.
default: identity
enum:
- gzip
- identity
responses:
"204":
description: Write data is correctly formatted and accepted for writing to the bucket.
"400":
description: Line protocol was not in correct format, and no points were written. Response can be used to determine the first malformed line in the line-protocol body. All data in body was rejected and not written.
content:
application/json:
schema:
$ref: "#/components/schemas/LineProtocolError"
"401":
description: Token does not have sufficient permissions to write to this organization and bucket or the organization and bucket do not exist.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"403":
description: No token was sent and they are required.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"413":
description: Write has been rejected because the payload is too large. Error message returns max size supported. All data in body was rejected and not written.
content:
application/json:
schema:
$ref: "#/components/schemas/LineProtocolLengthError"
"429":
description: Token is temporarily over quota. The Retry-After header describes when to try the write again.
headers:
Retry-After:
description: A non-negative decimal integer indicating the seconds to delay after the response is received.
schema:
type: integer
format: int32
"503":
description: Server is temporarily unavailable to accept writes. The Retry-After header describes when to try the write again.
headers:
Retry-After:
description: A non-negative decimal integer indicating the seconds to delay after the response is received.
schema:
type: integer
format: int32
default:
description: Internal server error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/query:
post: # technically this functions with other methods as well
operationId: PostQueryV1
tags:
- Query
summary: Query InfluxDB in a V1 compatible format
requestBody:
description: InfluxQL query to execute.
content:
text/plain: # although this should be `application/vnd.influxql`, oats breaks so we define the content-type header parameter
schema:
type: string
parameters:
- $ref: "#/components/parameters/TraceSpan"
- $ref: "#/components/parameters/AuthUserV1"
- $ref: "#/components/parameters/AuthPassV1"
- in: header
name: Accept
schema:
type: string
description: Specifies how query results should be encoded in the response. **Note:** With `application/csv`, query results include epoch timestamps instead of RFC3339 timestamps.
default: application/json
enum:
- application/json
- application/csv
- text/csv
- application/x-msgpack
- in: header
name: Accept-Encoding
description: The Accept-Encoding request HTTP header advertises which content encoding, usually a compression algorithm, the client is able to understand.
schema:
type: string
description: Specifies that the query response in the body should be encoded with gzip or not encoded with identity.
default: identity
enum:
- gzip
- identity
- in: header
name: Content-Type
schema:
type: string
enum:
- application/vnd.influxql
- in: query
name: q
description: Defines the influxql query to run.
schema:
type: string
responses:
"200":
description: Query results
headers:
Content-Encoding:
description: The Content-Encoding entity header is used to compress the media-type. When present, its value indicates which encodings were applied to the entity-body
schema:
type: string
description: Specifies that the response in the body is encoded with gzip or not encoded with identity.
default: identity
enum:
- gzip
- identity
Trace-Id:
description: The Trace-Id header reports the request's trace ID, if one was generated.
schema:
type: string
description: Specifies the request's trace ID.
content:
application/csv:
schema:
$ref: "#/components/schemas/InfluxQLCSVResponse"
text/csv:
schema:
$ref: "#/components/schemas/InfluxQLCSVResponse"
application/json:
schema:
$ref: "#/components/schemas/InfluxQLResponse"
application/x-msgpack:
schema:
type: string
format: binary
"429":
description: Token is temporarily over quota. The Retry-After header describes when to try the read again.
headers:
Retry-After:
description: A non-negative decimal integer indicating the seconds to delay after the response is received.
schema:
type: integer
format: int32
default:
description: Error processing query
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
components:
parameters:
TraceSpan:
in: header
name: Zap-Trace-Span
description: OpenTracing span context
example:
trace_id: "1"
span_id: "1"
baggage:
key: value
required: false
schema:
type: string
AuthUserV1:
in: query
name: u
required: false
schema:
type: string
description: Username.
AuthPassV1:
in: query
name: p
required: false
schema:
type: string
description: User token.
schemas:
InfluxQLResponse:
properties:
results:
type: array
items:
type: object
properties:
statement_id:
type: integer
series:
type: array
items:
type: object
properties:
name:
type: string
columns:
type: array
items:
type: integer
values:
type: array
items:
type: array
items: {}
InfluxQLCSVResponse:
type: string
example: >
name,tags,time,test_field,test_tag
test_measurement,,1603740794286107366,1,tag_value
test_measurement,,1603740870053205649,2,tag_value
test_measurement,,1603741221085428881,3,tag_value
Error:
properties:
code:
description: Code is the machine-readable error code.
readOnly: true
type: string
# This set of enumerations must remain in sync with the constants defined in errors.go
enum:
- internal error
- not found
- conflict
- invalid
- unprocessable entity
- empty value
- unavailable
- forbidden
- too many requests
- unauthorized
- method not allowed
message:
readOnly: true
description: Message is a human-readable message.
type: string
required: [code, message]
LineProtocolError:
properties:
code:
description: Code is the machine-readable error code.
readOnly: true
type: string
enum:
- internal error
- not found
- conflict
- invalid
- empty value
- unavailable
message:
readOnly: true
description: Message is a human-readable message.
type: string
op:
readOnly: true
description: Op describes the logical code operation during error. Useful for debugging.
type: string
err:
readOnly: true
description: Err is a stack of errors that occurred during processing of the request. Useful for debugging.
type: string
line:
readOnly: true
description: First line within sent body containing malformed data
type: integer
format: int32
required: [code, message, op, err]
LineProtocolLengthError:
properties:
code:
description: Code is the machine-readable error code.
readOnly: true
type: string
enum:
- invalid
message:
readOnly: true
description: Message is a human-readable message.
type: string
maxLength:
readOnly: true
description: Max length in bytes for a body of line-protocol.
type: integer
format: int32
required: [code, message, maxLength]

View File

@ -1,9 +1,9 @@
@import "tools/color-palette"; @import "tools/color-palette";
@import "tools/icomoon"; @import "tools/icomoon-v2";
// Fonts // Fonts
$rubik: 'Rubik', sans-serif; $rubik: 'Rubik', sans-serif;
$roboto-mono: 'Roboto Mono', monospace; $code: 'IBM Plex Mono', monospace;;
// Font weights // Font weights
$medium: 500; $medium: 500;
@ -60,7 +60,7 @@ $bold: 700;
} }
&:before { &:before {
content: "\e919"; content: "\e919";
font-family: 'icomoon'; font-family: 'icomoon-v2';
margin-right: .65rem; margin-right: .65rem;
} }
} }
@ -77,7 +77,7 @@ $bold: 700;
display: inline-block; display: inline-block;
font-size: .95rem; font-size: .95rem;
margin-right: .5rem; margin-right: .5rem;
font-family: 'icomoon'; font-family: 'icomoon-v2';
} }
&:hover { &:hover {
color: $g20-white; color: $g20-white;
@ -156,14 +156,14 @@ $bold: 700;
} }
.redoc-json { .redoc-json {
font-family: $roboto-mono !important; font-family: $code !important;
} }
// Inline Code // Inline Code
.flfxUM code, .flfxUM code,
.gDsWLk code, .gDsWLk code,
.kTVySD { .kTVySD {
font-family: $roboto-mono !important; font-family: $code !important;
color: $cp-marguerite; color: $cp-marguerite;
background: $cp-titan; background: $cp-titan;
border-color: $cp-titan; border-color: $cp-titan;
@ -275,7 +275,7 @@ $bold: 700;
background-color: $g2-kevlar; background-color: $g2-kevlar;
font-family: $rubik; font-family: $rubik;
} }
.iENVAs { font-family: $roboto-mono; } .iENVAs { font-family: $code; }
.dpMbau { font-family: $rubik; } .dpMbau { font-family: $rubik; }
// Code controls // Code controls
@ -285,7 +285,7 @@ $bold: 700;
} }
// Code blocks // Code blocks
.kZHJcC { font-family: $roboto-mono; } .kZHJcC { font-family: $code; }
.jCgylq { .jCgylq {
.token.string { .token.string {
color: $gr-honeydew; color: $gr-honeydew;

View File

@ -22,7 +22,6 @@
& + pre { margin-top: .5rem } & + pre { margin-top: .5rem }
& + .code-tabs-wrapper { margin-top: 0; } & + .code-tabs-wrapper { margin-top: 0; }
} }
.title { margin-bottom: 2.65rem; }
h1 { h1 {
font-weight: normal; font-weight: normal;
font-size: 2.65rem; font-size: 2.65rem;
@ -128,6 +127,7 @@
"article/tables", "article/tables",
"article/tags", "article/tags",
"article/telegraf-plugins", "article/telegraf-plugins",
"article/title",
"article/truncate", "article/truncate",
"article/video", "article/video",
"article/warn"; "article/warn";
@ -185,6 +185,12 @@
} }
.nowrap { white-space: nowrap } .nowrap { white-space: nowrap }
.all-caps {
text-transform: uppercase;
font-size: .95rem;
letter-spacing: .07em;
font-weight: $medium !important;
}
/////////////////////////// Getting Started Buttons ////////////////////////// /////////////////////////// Getting Started Buttons //////////////////////////
@ -213,10 +219,6 @@
.article { .article {
padding: 1.5rem 1.5rem 3rem; padding: 1.5rem 1.5rem 3rem;
.title {
margin-bottom: 2rem;
h1 { margin: .35em 0 .2em; font-size: 2.4rem; }
}
h2 { font-size: 1.9rem; } h2 { font-size: 1.9rem; }
h3 { font-size: 1.55rem; } h3 { font-size: 1.55rem; }
h4 { font-size: 1.3rem; } h4 { font-size: 1.3rem; }

View File

@ -72,7 +72,7 @@
&.back:before { &.back:before {
content: "\e90a"; content: "\e90a";
font-family: "icomoon"; font-family: "icomoon-v2";
margin-right: .35rem; margin-right: .35rem;
vertical-align: text-top; vertical-align: text-top;
} }

View File

@ -1,5 +1,5 @@
$rubik: 'Rubik', sans-serif; $rubik: 'Rubik', sans-serif;
$roboto-mono: 'Roboto Mono', monospace; $code: 'IBM Plex Mono', monospace;;
// Font weights // Font weights
$medium: 500; $medium: 500;

View File

@ -9,7 +9,7 @@
&.large:before { font-size: 1.1rem; } &.large:before { font-size: 1.1rem; }
&.add-btn-round { &.add-btn-round {
font-family: "icomoon"; font-family: "icomoon-v2";
color:#fff; color:#fff;
background: linear-gradient(45deg,#5c10a0,#8e1fc3); background: linear-gradient(45deg,#5c10a0,#8e1fc3);
border-radius:50%; border-radius:50%;
@ -21,6 +21,16 @@
height: 20px; height: 20px;
padding-left: .29rem; padding-left: .29rem;
line-height: 1.25rem; line-height: 1.25rem;
&.v3 {
position: relative;
background: $g5-pepper;
width: 18px;
height: 18px;
font-size: .65rem;
line-height: 0rem;
padding: 9px 0 0 4px;
}
} }
&.ui-toggle { &.ui-toggle {
@ -45,6 +55,16 @@
top: 4px; top: 4px;
right: 4px; right: 4px;
} }
&.v3 {
width: 26px;
.circle {
height: 12px;
width: 12px;
top: 2px;
right: 2px;
}
}
} }
} }
@ -200,10 +220,96 @@
} }
} }
} }
///////////////////////////////// CLOCKFACE V3 /////////////////////////////////
} }
.nav-items-v3 {
.nav-item-v3 {
display: inline-flex;
align-items: center;
margin: 0 1rem 1.25rem 0;
max-width: 225px;
background: linear-gradient(rgba(#052943, .9), rgba(#062238, .9));
color: $g20-white;
height: 60px;
border-radius: $radius;
&.account {
padding: 8px;
.acct-inner-v3 {
display: flex;
background-color: #f1f1f30d;
border-radius: $radius;
}
.acct-icon-v3 {
display: flex;
align-content: center;
justify-content: center;
font-weight: bold;
width: 44px;
height: 44px;
@include gradient($grad-Miyazakisky, 54deg);
border-radius: $radius;
.initial {
align-self: center;
}
}
.acct-label-v3 {
display: inline-block;
padding: 5px 0px 0px 8px;
width: 165px;
.username {
font-size: .75rem;
font-weight: 500;
color: #9e9ead;
}
.orgname {
font-size: .85rem;
line-height: 1.1rem;
}
}
}
}
.nav-icon-v3 {
display: flex;
justify-content: center;
align-items: center;
height: 100%;
width: 60px;
flex-shrink: 0;
}
p.nav-label-v3 {
display: inline-block;
margin: 0;
padding: 0;
font-weight: 500;
font-size: 1.15rem;
min-width: 225px;
color: $g20-white;
}
.cf-icon {
display: inline-block;
font-size: 1.35rem;
}
}
////////////////////////////////////////////////////////////////////////////////
///////////////////////////////// MEDIA QUERIES //////////////////////////////// ///////////////////////////////// MEDIA QUERIES ////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
@include media(small) { @include media(small) {
.article--content .nav-item:nth-child(2) {display: none;} .article--content.nav-item:nth-child(2) {display: none;}
.article--content.nav-item-v3:nth-child(2) {display: none;}
} }

View File

@ -28,7 +28,7 @@ $vertical-offset: -14px;
} }
& > a { & > a {
font-family: "icomoon"; font-family: "icomoon-v2";
color: rgba($article-text, .5); color: rgba($article-text, .5);
text-decoration: none; text-decoration: none;
} }

View File

@ -11,7 +11,7 @@
&:after { &:after {
content: "\e905"; content: "\e905";
display: block; display: block;
font-family: 'icomoon'; font-family: 'icomoon-v2';
position: absolute; position: absolute;
top: .15rem; top: .15rem;
right: .25rem; right: .25rem;
@ -167,46 +167,7 @@
text-decoration: none; text-decoration: none;
font-weight: $medium; font-weight: $medium;
display: inline-block; display: inline-block;
/////////////////////// Product exclusivity labels ///////////////////////
span:after{
display: inline-block;
position: relative;
top: -2px;
margin-left: .15rem;
padding: .45rem .18rem .35rem;
line-height: 0;
font-size: .6rem;
font-style: italic;
border-radius: 8px;
}
.cloud {
&:after {
content: "CLOUD";
color: $product-cloud;
border: 1px solid rgba($product-cloud, .5);
background: rgba($product-cloud, .1);
}
}
.oss {
&:after {
content: "OSS";
color: $product-oss;
border: 1px solid rgba($product-oss, .5);
background: rgba($product-oss, .1);
}
}
.enterprise {
&:after {
content: "ENT";
color: $product-enterprise;
border: 1px solid rgba($product-enterprise, .5);
background: rgba($product-enterprise, .1);
}
}
} }
////////////////////// End Product exclusivity labels //////////////////////
.nav-category > a { .nav-category > a {
color: $nav-category; color: $nav-category;
@ -277,7 +238,7 @@
// Nav section title styles // Nav section title styles
h4 { h4 {
margin: 2rem 0 0 -1rem; margin: 2rem 0 0 -1rem;
color: rgba($article-heading-alt, .6); color: rgba($article-heading-alt, .5);
font-style: italic; font-style: italic;
font-weight: 700; font-weight: 700;
text-transform: uppercase; text-transform: uppercase;
@ -287,7 +248,7 @@
&.platform, &.flux { &.platform, &.flux {
&:after { &:after {
content: "\e911"; content: "\e911";
font-family: "icomoon"; font-family: "icomoon-v2";
font-style: normal; font-style: normal;
font-size: 1rem; font-size: 1rem;
opacity: .4; opacity: .4;

View File

@ -7,7 +7,7 @@
z-index: 1; z-index: 1;
.influx-home { .influx-home {
font-family: 'icomoon'; font-family: 'icomoon-v2';
font-size: 1.9rem; font-size: 1.9rem;
color: $topnav-link; color: $topnav-link;
text-decoration: none; text-decoration: none;
@ -76,7 +76,7 @@
&:after { &:after {
content: "\e918"; content: "\e918";
font-family: 'icomoon'; font-family: 'icomoon-v2';
position: absolute; position: absolute;
top: .45rem; top: .45rem;
right: .4rem; right: .4rem;
@ -137,7 +137,7 @@
position: relative; position: relative;
&:after { &:after {
content: "\e911"; content: "\e911";
font-family: "icomoon"; font-family: "icomoon-v2";
position: absolute; position: absolute;
opacity: .4; opacity: .4;
margin-left: .25rem; margin-left: .25rem;
@ -154,7 +154,6 @@
.theme-switcher, #search-btn, .url-trigger { .theme-switcher, #search-btn, .url-trigger {
display: inline-block; display: inline-block;
padding: 0; padding: 0;
font-size: 1.8rem;
line-height: 0; line-height: 0;
color: rgba($topnav-link, .5); color: rgba($topnav-link, .5);
background: none; background: none;
@ -171,8 +170,8 @@
color: rgba($topnav-link, 1); color: rgba($topnav-link, 1);
cursor: pointer; cursor: pointer;
} }
&#theme-switch-dark { display: $theme-switch-dark; } &#theme-switch-dark { display: $theme-switch-dark; font-size: 1.15rem; }
&#theme-switch-light { display: $theme-switch-light; } &#theme-switch-light { display: $theme-switch-light; font-size: 1.3rem; }
} }
.url-trigger { .url-trigger {

View File

@ -332,7 +332,7 @@ label:after {
content: "\e924"; content: "\e924";
display: inline-block; display: inline-block;
margin-right: .35rem; margin-right: .35rem;
font-family: "icomoon"; font-family: "icomoon-v2";
font-style: normal; font-style: normal;
font-size: .8rem; font-size: .8rem;
} }

View File

@ -4,7 +4,7 @@ a.btn {
position: relative; position: relative;
display: inline-block; display: inline-block;
margin: .5rem .25rem .5rem 0; margin: .5rem .25rem .5rem 0;
padding: .5rem 1rem; padding: 0.85rem 1.5rem;
color: $article-btn-text !important; color: $article-btn-text !important;
border-radius: $radius; border-radius: $radius;
font-size: .95rem; font-size: .95rem;
@ -36,14 +36,14 @@ a.btn {
&.download:before { &.download:before {
content: "\e91d"; content: "\e91d";
font-family: "icomoon"; font-family: "icomoon-v2";
margin-right: .5rem; margin-right: .5rem;
font-size: 1.1rem; font-size: 1.1rem;
} }
&.github:before { &.github:before {
content: "\eab0"; content: "\eab0";
font-family: "icomoon"; font-family: "icomoon-v2";
margin-right: .5rem; margin-right: .5rem;
font-size: 1.1rem; font-size: 1.1rem;
} }

View File

@ -6,7 +6,7 @@
a a:after { a a:after {
content: "\e91a"; content: "\e91a";
font-family: "icomoon"; font-family: "icomoon-v2";
color: rgba($article-heading, .35); color: rgba($article-heading, .35);
vertical-align: bottom; vertical-align: bottom;
transition: color .2s; transition: color .2s;

View File

@ -2,7 +2,7 @@
code,pre { code,pre {
background: $article-code-bg; background: $article-code-bg;
font-family: $roboto-mono; font-family: $code;
color: $article-code; color: $article-code;
} }

View File

@ -33,7 +33,7 @@
color: $article-heading-alt; color: $article-heading-alt;
margin: 0 .25rem 0 -.25rem; margin: 0 .25rem 0 -.25rem;
font-size: 1.65rem; font-size: 1.65rem;
font-family: 'icomoon'; font-family: 'icomoon-v2';
vertical-align: middle; vertical-align: middle;
} }
&.slack:before { &.slack:before {
@ -54,7 +54,7 @@
a { a {
display: block; display: block;
padding-left: .7rem; padding-left: 1rem;
font-size: .85rem; font-size: .85rem;
&.btn { &.btn {
@ -69,8 +69,8 @@
&:before { &:before {
display: inline-block; display: inline-block;
margin-right: .5rem; margin-right: .7rem;
font-family: 'icomoon'; font-family: 'icomoon-v2';
} }
&.edit:before { &.edit:before {

View File

@ -1,16 +1,5 @@
//////////////////////// Styles unique to the Flux docs //////////////////////// //////////////////////// Styles unique to the Flux docs ////////////////////////
.title .meta {
margin-bottom: 0;
padding: 0 .65em 0 .75em;
color: $article-heading;
background: rgba($article-heading, .07);
font-size: .9rem;
font-weight: $medium;
border-radius: 1em;
display: inline-block;
}
h2,h3,h4 { h2,h3,h4 {
&:after { &:after {
content: attr(data-type); content: attr(data-type);

View File

@ -4,7 +4,7 @@
display: inline-block; display: inline-block;
margin: 1rem 0 2rem; margin: 1rem 0 2rem;
padding: 1.5rem 2.5rem 1.5rem 1.5rem; padding: 1.5rem 2.5rem 1.5rem 1.5rem;
font-family: $roboto-mono; font-family: $code;
border-radius: $radius; border-radius: $radius;
box-shadow: 1px 3px 10px $article-shadow; box-shadow: 1px 3px 10px $article-shadow;
& > ul { padding: 0; margin: 0; & > ul { padding: 0; margin: 0;

View File

@ -17,7 +17,7 @@
&:before { &:before {
content: "\e90a"; content: "\e90a";
display: inline-block; display: inline-block;
font-family: "icomoon"; font-family: "icomoon-v2";
margin-right: .5rem; margin-right: .5rem;
vertical-align: middle; vertical-align: middle;
} }
@ -29,7 +29,7 @@
&:before { &:before {
content: "\e90c"; content: "\e90c";
display: inline-block; display: inline-block;
font-family: "icomoon"; font-family: "icomoon-v2";
margin-left: .5rem; margin-left: .5rem;
vertical-align: middle; vertical-align: middle;
} }

View File

@ -1,23 +1,5 @@
svg { svg {
&#join-vs-union {
max-width: 525px;
width: 100%;
margin-bottom: 2rem;
.st0{fill: $svg-table-code-bg;}
.st1{fill: $svg-table-header;}
.st2{fill: $svg-table-row-alt1;}
.st3{fill:none;stroke: $svg-table-stroke;stroke-width:2;stroke-miterlimit:10;}
.st4{fill:none;stroke: $svg-table-stroke;stroke-width:4;stroke-miterlimit:10;}
.st5{fill: $svg-table-row-alt2;}
.st6{fill: $svg-table-code;}
.st7{font-family:'Roboto Mono';}
.st8{font-size:14.2px;}
.st9{fill: $svg-table-code-operator;}
.st10{fill: $svg-table-code-string;}
}
&[id^='geo-s2-cells-'] { &[id^='geo-s2-cells-'] {
max-width: 250px; max-width: 250px;
.geo-cell{fill:rgba($svg-geo-s2-cell, 0.25);stroke:$svg-geo-s2-cell;stroke-width:3;stroke-linejoin:round;stroke-miterlimit:10;} .geo-cell{fill:rgba($svg-geo-s2-cell, 0.25);stroke:$svg-geo-s2-cell;stroke-width:3;stroke-linejoin:round;stroke-miterlimit:10;}

View File

@ -14,7 +14,7 @@
position: relative; position: relative;
font-size: 0.875rem; font-size: 0.875rem;
font-weight: $medium; font-weight: $medium;
padding: .35rem .75rem; padding: .65rem 1.25rem;
display: inline-block; display: inline-block;
text-align: center; text-align: center;
color: $article-tab-text !important; color: $article-tab-text !important;
@ -56,7 +56,7 @@
p { justify-content: flex-start; } p { justify-content: flex-start; }
a { a {
flex-grow: unset; flex-grow: unset;
padding: 0rem .5rem; padding: .35rem 1rem;
} }
} }
} }

View File

@ -0,0 +1,35 @@
////////////// Styles for the title block at the top of each page //////////////
.title {
margin-bottom: 2.65rem;
.meta {
margin-bottom: 0;
padding: 0 .65em 0 .75em;
color: $article-heading;
background: rgba($article-heading, .07);
font-size: .9rem;
font-weight: $medium;
border-radius: 1em;
display: inline-block;
&.updated-in {
padding: 0 0 0 .4em;
background: none;
font-weight: normal;
font-style: italic;
color: rgba($article-heading, .6)
}
}
}
////////////////////////////////////////////////////////////////////////////////
///////////////////////////////// MEDIA QUERIES ////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
@include media(small) {
.title {
margin-bottom: 2rem;
h1 { margin: .35em 0 .2em; font-size: 2.4rem; }
}
}

View File

@ -1,6 +1,6 @@
.warn { .warn {
border-color: $article-warn-base; border-color: $article-warn-base;
background: rgba($article-warn-base, .08); background: $article-warn-bg;
h1,h2,h3,h4,h5,h6 { h1,h2,h3,h4,h5,h6 {
color: $article-warn-heading; color: $article-warn-heading;
} }

View File

@ -1,7 +1,8 @@
// InfluxData Docs Default Theme (Light) // InfluxData Docs Default Theme (Light)
// Import Tools // Import Tools
@import "tools/icomoon", @import "tools/icomoon-v2",
"tools/icon",
"tools/media-queries.scss", "tools/media-queries.scss",
"tools/mixins.scss", "tools/mixins.scss",
"tools/tooltips", "tools/tooltips",

View File

@ -14,7 +14,7 @@
@import "tools/color-palette"; @import "tools/color-palette";
$body-bg: $g0-obsidian; $body-bg: $grey5;
// TopNav Colors // TopNav Colors
$topnav-link: $g20-white; $topnav-link: $g20-white;
@ -24,7 +24,7 @@ $theme-switch-light: inline-block;
$theme-switch-dark: none; $theme-switch-dark: none;
// Search // Search
$sidebar-search-bg: $g2-kevlar; $sidebar-search-bg: $grey15;
$sidebar-search-shadow: rgba($g0-obsidian, .05); $sidebar-search-shadow: rgba($g0-obsidian, .05);
$sidebar-search-highlight: $b-pool; $sidebar-search-highlight: $b-pool;
$sidebar-search-text: $g20-white; $sidebar-search-text: $g20-white;
@ -34,7 +34,7 @@ $nav-category: $b-pool;
$nav-category-hover: $g20-white; $nav-category-hover: $g20-white;
$nav-item: $g15-platinum; $nav-item: $g15-platinum;
$nav-item-hover: $b-pool; $nav-item-hover: $b-pool;
$nav-border: $g5-pepper; $nav-border: $grey25;
$nav-toggle: $g16-pearl; $nav-toggle: $g16-pearl;
$nav-toggle-hover: $g16-pearl; $nav-toggle-hover: $g16-pearl;
$nav-toggle-bg-hover: $b-pool; $nav-toggle-bg-hover: $b-pool;
@ -46,7 +46,7 @@ $product-oss: $p-potassium;
$product-enterprise: $br-galaxy; $product-enterprise: $br-galaxy;
// Article Content // Article Content
$article-bg: $g1-raven; $article-bg: $grey10;
$article-heading: $g20-white; $article-heading: $g20-white;
$article-heading-alt: $g19-ghost; $article-heading-alt: $g19-ghost;
$article-text: $g15-platinum; $article-text: $g15-platinum;
@ -54,11 +54,11 @@ $article-bold: $g19-ghost;
$article-link: $b-pool; $article-link: $b-pool;
$article-link-hover: $g20-white; $article-link-hover: $g20-white;
$article-hr: $g5-pepper; $article-hr: $g5-pepper;
$article-shadow: $g0-obsidian; $article-shadow: $grey5;
// Article Code // Article Code
$article-code: $cp-munchkin; $article-code: $cp-munchkin;
$article-code-bg: $g0-obsidian; $article-code-bg: $grey5;
$article-code-shadow: $g0-obsidian; $article-code-shadow: $g0-obsidian;
$article-code-accent1: $g7-graphite; $article-code-accent1: $g7-graphite;
$article-code-accent2: $b-pool; $article-code-accent2: $b-pool;
@ -74,7 +74,7 @@ $article-code-scrollbar: $g3-castle;
// Article Tables // Article Tables
$article-table-header: $grad-GundamPilot; $article-table-header: $grad-GundamPilot;
$article-table-row-alt: $g3-castle; $article-table-row-alt: $grey20;
$article-table-scrollbar: $g0-obsidian; $article-table-scrollbar: $g0-obsidian;
// Article Notes, Warnings, & Messages // Article Notes, Warnings, & Messages
@ -89,7 +89,7 @@ $article-note-table-row-alt: #1a3c34;
$article-note-table-scrollbar: #162627; $article-note-table-scrollbar: #162627;
$article-note-shadow: $g0-obsidian; $article-note-shadow: $g0-obsidian;
$article-note-code: $br-galaxy; $article-note-code: $br-galaxy;
$article-note-code-bg: #0d1617; $article-note-code-bg: #040d0e;
$article-note-code-accent1: #567375; $article-note-code-accent1: #567375;
$article-note-code-accent2: $b-pool; $article-note-code-accent2: $b-pool;
$article-note-code-accent3: $gr-viridian; $article-note-code-accent3: $gr-viridian;
@ -100,6 +100,7 @@ $article-note-code-accent7: #e90;
$article-note-code-scrollbar: #162627; $article-note-code-scrollbar: #162627;
$article-warn-base: $r-dreamsicle; $article-warn-base: $r-dreamsicle;
$article-warn-bg: #ff61851a;
$article-warn-heading: $g20-white; $article-warn-heading: $g20-white;
$article-warn-text: $r-tungsten; $article-warn-text: $r-tungsten;
$article-warn-link: $r-marmelade; $article-warn-link: $r-marmelade;
@ -107,9 +108,9 @@ $article-warn-link-hover: $g20-white;
$article-warn-table-header: $grad-red; $article-warn-table-header: $grad-red;
$article-warn-table-row-alt: #4a2a2a; $article-warn-table-row-alt: #4a2a2a;
$article-warn-table-scrollbar: #1f181b; $article-warn-table-scrollbar: #1f181b;
$article-warn-shadow: $g0-obsidian; $article-warn-shadow: #0d0610;
$article-warn-code: #ec6e6e; $article-warn-code: #ec6e6e;
$article-warn-code-bg: $g0-obsidian; $article-warn-code-bg: #0d0610;
$article-warn-code-accent1: #844c4c; $article-warn-code-accent1: #844c4c;
$article-warn-code-accent2: $b-pool; $article-warn-code-accent2: $b-pool;
$article-warn-code-accent3: $gr-viridian; $article-warn-code-accent3: $gr-viridian;
@ -129,7 +130,7 @@ $article-cloud-table-row-alt: #1b3a58;
$article-cloud-table-scrollbar: #192a3a; $article-cloud-table-scrollbar: #192a3a;
$article-cloud-shadow: $g0-obsidian; $article-cloud-shadow: $g0-obsidian;
$article-cloud-code: $b-laser; $article-cloud-code: $b-laser;
$article-cloud-code-bg: #110d2b; $article-cloud-code-bg: #0a071c;
$article-cloud-code-accent1: #567375; $article-cloud-code-accent1: #567375;
$article-cloud-code-accent2: $b-pool; $article-cloud-code-accent2: $b-pool;
$article-cloud-code-accent3: $gr-viridian; $article-cloud-code-accent3: $gr-viridian;
@ -146,7 +147,7 @@ $article-enterprise-link-hover: $g20-white;
// Article Tabs for tabbed content // Article Tabs for tabbed content
$article-tab-text: $g12-forge; $article-tab-text: $g12-forge;
$article-tab-bg: $g0-obsidian; $article-tab-bg: $grey5;
$article-tab-active-text: $g20-white; $article-tab-active-text: $g20-white;
$article-tab-active-bg: $b-pool; $article-tab-active-bg: $b-pool;
@ -180,7 +181,7 @@ $landing-btn-grad-hover: $grad-blue-light;
// Home page colors // Home page colors
$home-btn-gradient: $grad-NineteenEightyFour; $home-btn-gradient: $grad-NineteenEightyFour;
$home-btn-gradient-hover: $grad-PastelGothic; $home-btn-gradient-hover: $grad-PastelGothic;
$home-tick-bg-gradient: $grad-grey-abyss; $home-tick-bg-gradient: $grad-cool-grey-abyss;
$default-home-card-gradient: $grad-Miyazakisky; $default-home-card-gradient: $grad-Miyazakisky;
// Tooltip colors // Tooltip colors
@ -190,7 +191,7 @@ $tooltip-bg: $br-chartreuse;
$tooltip-text: $g2-kevlar; $tooltip-text: $g2-kevlar;
// Support and feedback buttons // Support and feedback buttons
$feedback-btn-bg: $g3-castle; $feedback-btn-bg: $grey25;
// URL Modal colors // URL Modal colors
$modal-field-bg: $g1-raven; $modal-field-bg: $g1-raven;

View File

@ -14,8 +14,8 @@
// General Styles // General Styles
// -------------------------------------------------- // --------------------------------------------------
$body-bg: $g18-cloud !default; $body-bg: #f3f4fb !default;
$radius: 3px !default; $radius: 2px !default;
// TopNav Colors // TopNav Colors
$topnav-link: $g8-storm !default; $topnav-link: $g8-storm !default;
@ -26,7 +26,7 @@ $theme-switch-dark: inline-block !default;
// Search // Search
$sidebar-search-bg: $g20-white !default; $sidebar-search-bg: $g20-white !default;
$sidebar-search-shadow: $g14-chromium !default; $sidebar-search-shadow: #cfd1e5 !default;
$sidebar-search-highlight: $b-pool !default; $sidebar-search-highlight: $b-pool !default;
$sidebar-search-text: $g8-storm !default; $sidebar-search-text: $g8-storm !default;
@ -54,7 +54,7 @@ $article-text: $g6-smoke !default;
$article-bold: $g6-smoke !default; $article-bold: $g6-smoke !default;
$article-link: $b-pool !default; $article-link: $b-pool !default;
$article-link-hover: $br-magenta !default; $article-link-hover: $br-magenta !default;
$article-shadow: $g14-chromium !default; $article-shadow: #cfd1e5 !default;
$article-hr: $g15-platinum !default; $article-hr: $g15-platinum !default;
// Article Code // Article Code
@ -75,7 +75,7 @@ $article-code-scrollbar: $cp-periwinkle !default;
// Article Tables // Article Tables
$article-table-header: $grad-Miyazakisky !default; $article-table-header: $grad-Miyazakisky !default;
$article-table-row-alt: #F6F7F8 !default; $article-table-row-alt: #f6f8ff !default;
$article-table-scrollbar: $g14-chromium !default; $article-table-scrollbar: $g14-chromium !default;
// Article Notes & Warnings // Article Notes & Warnings
@ -101,6 +101,7 @@ $article-note-code-accent7: #e90 !default;
$article-note-code-scrollbar: #87DABE !default; $article-note-code-scrollbar: #87DABE !default;
$article-warn-base: $r-dreamsicle !default; $article-warn-base: $r-dreamsicle !default;
$article-warn-bg: rgba($r-dreamsicle, .08) !default;
$article-warn-heading: $r-fire !default; $article-warn-heading: $r-fire !default;
$article-warn-text: $r-curacao !default; $article-warn-text: $r-curacao !default;
$article-warn-link: $r-curacao !default; $article-warn-link: $r-curacao !default;
@ -110,7 +111,7 @@ $article-warn-table-row-alt: #ffe6df !default;
$article-warn-table-scrollbar: #FFB1B1 !default; $article-warn-table-scrollbar: #FFB1B1 !default;
$article-warn-shadow: #b98a7d !default; $article-warn-shadow: #b98a7d !default;
$article-warn-code: #d0154e !default; $article-warn-code: #d0154e !default;
$article-warn-code-bg: #FFDDDC !default; $article-warn-code-bg: #fde6e5 !default;
$article-warn-code-accent1: #fd99b8 !default; $article-warn-code-accent1: #fd99b8 !default;
$article-warn-code-accent2: #357ae8 !default; $article-warn-code-accent2: #357ae8 !default;
$article-warn-code-accent3: #6c59cc !default; $article-warn-code-accent3: #6c59cc !default;
@ -147,7 +148,7 @@ $article-enterprise-link-hover: $b-pool !default;
// Article Tabs for tabbed content // Article Tabs for tabbed content
$article-tab-text: $g8-storm !default; $article-tab-text: $g8-storm !default;
$article-tab-bg: $g18-cloud !default; $article-tab-bg: $grey95 !default;
$article-tab-active-text: $g20-white !default; $article-tab-active-text: $g20-white !default;
$article-tab-active-bg: $b-pool !default; $article-tab-active-bg: $b-pool !default;
$article-tab-code-text: $cp-marguerite !default; $article-tab-code-text: $cp-marguerite !default;

View File

@ -148,3 +148,21 @@ $grad-PurpleRain: $p-void, $cp-marguerite;
// Transparent gradients // Transparent gradients
$grad-whiteFade: rgba($g20-white, .75), rgba($g20-white, 0); $grad-whiteFade: rgba($g20-white, .75), rgba($g20-white, 0);
////////////////////////////// CLOCKFACE 3 COLORS //////////////////////////////
$grey5: #07070E;
$grey10: #14141F;
$grey15: #1A1A2A;
$grey20: #262738;
$grey25: #333346;
$grey35: #4D4D60;
$grey45: #68687B;
$grey55: #828294;
$grey65: #9E9EAD;
$grey75: #B9B9C5;
$grey85: #D5D5DD;
$grey95: #F1F1F3;
$white: #FFFFFF;
$grad-cool-grey-abyss: $grey10, $grey15;

View File

@ -1,10 +1,10 @@
@font-face { @font-face {
font-family: 'icomoon'; font-family: 'icomoon-v2';
src: url('fonts/icomoon.eot?itn2ph'); src: url('fonts/icomoon-v2.eot?itn2ph');
src: url('fonts/icomoon.eot?itn2ph#iefix') format('embedded-opentype'), src: url('fonts/icomoon-v2.eot?itn2ph#iefix') format('embedded-opentype'),
url('fonts/icomoon.ttf?itn2ph') format('truetype'), url('fonts/icomoon-v2.ttf?itn2ph') format('truetype'),
url('fonts/icomoon.woff?itn2ph') format('woff'), url('fonts/icomoon-v2.woff?itn2ph') format('woff'),
url('fonts/icomoon.svg?itn2ph#icomoon') format('svg'); url('fonts/icomoon-v2.svg?itn2ph#icomoon-v2') format('svg');
font-weight: normal; font-weight: normal;
font-style: normal; font-style: normal;
font-display: block; font-display: block;
@ -12,7 +12,7 @@
[class^="icon-"], [class*=" icon-"] { [class^="icon-"], [class*=" icon-"] {
/* use !important to prevent issues with browser extensions that change fonts */ /* use !important to prevent issues with browser extensions that change fonts */
font-family: 'icomoon' !important; font-family: 'icomoon-v2' !important;
speak: never; speak: never;
font-style: normal; font-style: normal;
font-weight: normal; font-weight: normal;

View File

@ -0,0 +1,525 @@
/*
Icon Font
-----------------------------------------------------------------------------
Created using a tool called IcoMoon
See more at http://icomoon.io
*/
@font-face {
font-family: 'icomoon';
src: url('fonts/icomoon.eot') format('embedded-opentype');
src: url('fonts/icomoon.eot') format('embedded-opentype'),
url('fonts/icomoon.woff2') format('woff2'),
url('fonts/icomoon.ttf') format('truetype'),
url('fonts/icomoon.woff') format('woff'),
url('fonts/icomoon.svg') format('svg');
font-weight: normal;
font-style: normal;
}
.cf-icon {
font-family: 'icomoon' !important;
font-style: normal;
font-weight: normal;
font-variant: normal;
text-transform: none;
line-height: 1;
// Better Font Rendering
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
&.add-cell-new:before {
content: '\e976';
}
&.alert-triangle-new:before {
content: '\e977';
}
&.annotate-new:before {
content: '\e978';
}
&.arrow-down-new:before {
content: '\e979';
}
&.arrow-left-new:before {
content: '\e97a';
}
&.arrow-right-new:before {
content: '\e97b';
}
&.arrow-up-new:before {
content: '\e97c';
}
&.bar-chart-new:before {
content: '\e97d';
}
&.build-outline-new:before {
content: '\e97e';
}
&.caret-down-new:before {
content: '\e97f';
}
&.caret-left-new:before {
content: '\e980';
}
&.caret-right-new:before {
content: '\e981';
}
&.caret-up-new:before {
content: '\e982';
}
&.checkmark-new:before {
content: '\e983';
}
&.clipboard-new:before {
content: '\e984';
}
&.clock-new:before {
content: '\e985';
}
&.cog-outline-new:before {
content: '\e986';
}
&.cog-solid-new:before {
content: '\e987';
}
&.crown-solid-new:before {
content: '\e988';
}
&.dark-mode-new:before {
content: '\e989';
}
&.download-new:before {
content: '\e98a';
}
&.duplicate-new:before {
content: '\e98b';
}
&.expand-new:before {
content: '\e98c';
}
&.export-new:before {
content: '\e98d';
}
&.eye-open-new:before {
content: '\e98e';
}
&.graph-line-new:before {
content: '\e98f';
}
&.handle-new:before {
content: '\e990';
}
&.home-outline-new:before {
content: '\e991';
}
&.info-new:before {
content: '\e992';
}
&.ingest-new:before {
content: '\e993';
}
&.light-mode-new:before {
content: '\e994';
}
&.lock-outline-new:before {
content: '\e995';
}
&.log-out-new:before {
content: '\e996';
}
&.pin-new:before {
content: '\e997';
}
&.plus-new:before {
content: '\e998';
}
&.question-mark-new:before {
content: '\e999';
}
&.refresh-new:before {
content: '\e99a';
}
&.remove-new:before {
content: '\e99b';
}
&.search-new:before {
content: '\e99c';
}
&.sidebar-close-new:before {
content: '\e99d';
}
&.sidebar-open-new:before {
content: '\e99e';
}
&.stop-new:before {
content: '\e99f';
}
&.switch-new:before {
content: '\e9a0';
}
&.text-new:before {
content: '\e9a1';
}
&.trash-new:before {
content: '\e9a2';
}
&.user-outline-new:before {
content: '\e9a3';
}
&.more:before {
content: '\e974';
}
&.drag-to-expand-white:before {
content: '\e901';
color: #fff;
}
&.drag-to-expand:before {
content: '\e902';
}
&.shield-solid:before {
content: '\e903';
}
&.lock:before {
content: '\e900';
}
&.heart-solid:before {
content: '\e96f';
}
&.bucket-outline:before {
content: '\e961';
}
&.chat:before {
content: '\e933';
}
&.currency-eur:before {
content: '\e968';
}
&.currency-gbp:before {
content: '\e969';
}
&.currency-usd:before {
content: '\e96a';
}
&.moon:before {
content: '\e95c';
}
&.share-solid:before {
content: '\e96e';
}
&.shield:before {
content: '\e96b';
}
&.sun:before {
content: '\e95d';
}
&.upgrade:before {
content: '\e95f';
}
&.merge:before {
content: '\e975';
}
&.add-cell:before {
content: '\e925';
}
&.alert-triangle:before {
content: '\e926';
}
&.alerts:before {
content: '\e921';
}
&.annotate:before {
content: '\e953';
}
&.annotate-plus:before {
content: '\e952';
}
&.authzero:before {
content: '\e951';
}
&.bar-chart:before {
content: '\e913';
}
&.bell:before {
content: '\e934';
}
&.bell-solid:before {
content: '\e937';
}
&.brush:before {
content: '\e93d';
}
&.capacitor2:before {
content: '\e923';
}
&.caret-down:before {
content: '\e904';
}
&.caret-left:before {
content: '\e905';
}
&.caret-right:before {
content: '\e906';
}
&.caret-up:before {
content: '\e907';
}
&.checkmark:before {
content: '\e918';
}
&.circle:before {
content: '\e940';
}
&.circle-thick:before {
content: '\e90e';
}
&.clock:before {
content: '\e920';
}
&.cog-outline:before {
content: '\e91c';
}
&.cog-thick:before {
content: '\e90c';
}
&.collapse:before {
content: '\e91b';
}
&.crown-outline:before {
content: '\e908';
}
&.crown2:before {
content: '\e94b';
}
&.cube:before {
content: '\e90b';
}
&.cubo:before {
content: '\e95e';
}
&.cubo-uniform:before {
content: '\e93c';
}
&.dash-f:before {
content: '\e927';
}
&.dash-h:before {
content: '\e929';
}
&.dash-j:before {
content: '\e92b';
}
&.disks:before {
content: '\e950';
}
&.download:before {
content: '\e91d';
}
&.duplicate:before {
content: '\e917';
}
&.erlenmeyer:before {
content: '\e958';
}
&.expand-a:before {
content: '\e944';
}
&.expand-b:before {
content: '\e942';
}
&.export:before {
content: '\e90f';
}
&.eye:before {
content: '\e91f';
}
&.eye-closed:before {
content: '\e956';
}
&.eye-open:before {
content: '\e957';
}
&.fn:before {
content: '\e960';
}
&.github:before {
content: '\e928';
}
&.google:before {
content: '\e92a';
}
&.group:before {
content: '\e909';
}
&.heroku:before {
content: '\e947';
}
&.heroku-simple:before {
content: '\e948';
}
&.import:before {
content: '\e910';
}
&.link:before {
content: '\e92e';
}
&.maximize:before {
content: '\e955';
}
&.minimize:before {
content: '\e954';
}
&.nav-chat:before {
content: '\e941';
}
&.oauth:before {
content: '\e94f';
}
&.octagon:before {
content: '\e92d';
}
&.okta:before {
content: '\e912';
}
&.pause:before {
content: '\e94a';
}
&.pencil:before {
content: '\e92f';
}
&.play:before {
content: '\e914';
}
&.plus:before {
content: '\e90a';
}
&.plus-skinny:before {
content: '\e922';
}
&.polaroid:before {
content: '\e95b';
}
&.pulse-c:before {
content: '\e936';
}
&.redo:before {
content: '\e959';
}
&.refresh:before {
content: '\e949';
}
&.remove:before {
content: '\e90d';
}
&.search:before {
content: '\e916';
}
&.server2:before {
content: '\e94c';
}
&.shuffle:before {
content: '\e94e';
}
&.square:before {
content: '\e93e';
}
&.square-check:before {
content: '\e943';
}
&.star:before {
content: '\e930';
}
&.stop:before {
content: '\e931';
}
&.text-block:before {
content: '\e911';
}
&.trash:before {
content: '\e915';
}
&.triangle:before {
content: '\e92c';
}
&.undo:before {
content: '\e95a';
}
&.user:before {
content: '\e919';
}
&.user-add:before {
content: '\e91e';
}
&.user-outline:before {
content: '\e932';
}
&.user-remove:before {
content: '\e939';
}
&.users-trio:before {
content: '\e945';
}
&.wand:before {
content: '\e94d';
}
&.wood:before {
content: '\e970';
}
&.wrench:before {
content: '\e971';
}
&.zap:before {
content: '\e973';
}
&.bell-ringing:before {
content: '\e935';
}
&.calendar:before {
content: '\e938';
}
&.cloud:before {
content: '\e93f';
}
&.cubo-nav:before {
content: '\e91a';
}
&.dashboards:before {
content: '\e93a';
}
&.disks-nav:before {
content: '\e946';
}
&.graphline-2:before {
content: '\e924';
}
&.users-duo:before {
content: '\e93b';
}
&.wrench-nav:before {
content: '\e972';
}
&.book:before {
content: '\e966';
}
&.book-code:before {
content: '\e967';
}
&.book-pencil:before {
content: '\e965';
}
&.bucket-solid:before {
content: '\e962';
}
&.funnel-outline:before {
content: '\e963';
}
&.funnel-solid:before {
content: '\e964';
}
&.layers:before {
content: '\e96c';
}
&.share:before {
content: '\e96d';
}
}

View File

@ -4,9 +4,6 @@
$medium: 500; $medium: 500;
$bold: 700; $bold: 700;
// Border radius
$radius: 3px;
////////////////////////////////// Tool Tips ////////////////////////////////// ////////////////////////////////// Tool Tips //////////////////////////////////
.tooltip { .tooltip {

View File

@ -25,8 +25,10 @@ hrefTargetBlank = true
smartDashes = false smartDashes = false
[taxonomies] [taxonomies]
"influxdb/v2.1/tag" = "influxdb/v2.1/tags"
"influxdb/v2.0/tag" = "influxdb/v2.0/tags" "influxdb/v2.0/tag" = "influxdb/v2.0/tags"
"influxdb/cloud/tag" = "influxdb/cloud/tags" "influxdb/cloud/tag" = "influxdb/cloud/tags"
"flux/v0.x/tag" = "flux/v0.x/tags"
[markup] [markup]
[markup.goldmark] [markup.goldmark]

View File

@ -21,6 +21,7 @@ hrefTargetBlank = true
smartDashes = false smartDashes = false
[taxonomies] [taxonomies]
"influxdb/v2.1/tag" = "influxdb/v2.1/tags"
"influxdb/v2.0/tag" = "influxdb/v2.0/tags" "influxdb/v2.0/tag" = "influxdb/v2.0/tags"
"influxdb/cloud/tag" = "influxdb/cloud/tags" "influxdb/cloud/tag" = "influxdb/cloud/tags"
"flux/v0.x/tag" = "flux/v0.x/tags" "flux/v0.x/tag" = "flux/v0.x/tags"

View File

@ -33,7 +33,7 @@ of the default retention policy.
Use the Chronograf **Admin page** to modify the retention policy in the `chronograf` database. Use the Chronograf **Admin page** to modify the retention policy in the `chronograf` database.
In the Databases tab: In the Databases tab:
1. Click **{{< icon "crown" >}} InfluxDB Admin** in the left navigation bar. 1. Click **{{< icon "crown" "v2" >}} InfluxDB Admin** in the left navigation bar.
2. Hover over the retention policy list of the `chronograf` database and click **Edit** 2. Hover over the retention policy list of the `chronograf` database and click **Edit**
next to the retention policy to update. next to the retention policy to update.
3. Update the **Duration** of the retention policy. 3. Update the **Duration** of the retention policy.
@ -55,7 +55,7 @@ Chronograf lets you manage Kapacitor TICKscript tasks created in Kapacitor or in
Chronograf when [creating a Chronograf alert rule](/chronograf/v1.9/guides/create-alert-rules/). Chronograf when [creating a Chronograf alert rule](/chronograf/v1.9/guides/create-alert-rules/).
To manage Kapacitor TICKscript tasks in Chronograf, click To manage Kapacitor TICKscript tasks in Chronograf, click
**{{< icon "alert">}} Alerts** in the left navigation bar. **{{< icon "alert" "v2">}} Alerts** in the left navigation bar.
On this page, you can: On this page, you can:
- View Kapacitor TICKscript tasks. - View Kapacitor TICKscript tasks.
@ -70,7 +70,7 @@ On this page, you can:
Chronograf lets you view and manage [Kapacitor Flux tasks](/{{< latest "kapacitor" >}}/working/flux/). Chronograf lets you view and manage [Kapacitor Flux tasks](/{{< latest "kapacitor" >}}/working/flux/).
To manage Kapacitor Flux tasks in Chronograf, click To manage Kapacitor Flux tasks in Chronograf, click
**{{< icon "alert">}} Alerts** in the left navigation bar. **{{< icon "alert" "v2">}} Alerts** in the left navigation bar.
On this page, you can: On this page, you can:
- View Kapacitor Flux tasks. - View Kapacitor Flux tasks.

View File

@ -94,10 +94,10 @@ To copy the complete, un-truncated log message, select the message cell and clic
## Show or hide the log status histogram ## Show or hide the log status histogram
The Chronograf Log Viewer displays a histogram of log status. The Chronograf Log Viewer displays a histogram of log status.
**To hide the log status histogram**, click the **{{< icon "hide" >}} icon** in **To hide the log status histogram**, click the **{{< icon "hide" "v2" >}} icon** in
the top right corner of the histogram. the top right corner of the histogram.
**To show the log status histogram**, click the **{{< icon "bar-chart" >}} icon** **To show the log status histogram**, click the **{{< icon "bar-chart" "v2" >}} icon**
in the top right corner of the log output. in the top right corner of the log output.
## Logs in dashboards ## Logs in dashboards

View File

@ -253,7 +253,7 @@ To enable a new "Generic API" service using TICKscript, see [AlertNode (Kapacito
1. In the **Configure Alert Endpoints** of the **Configure Kapacitor Connection** page, 1. In the **Configure Alert Endpoints** of the **Configure Kapacitor Connection** page,
click the **Slack** tab. click the **Slack** tab.
2. Click **{{< icon "plus" >}} Add Another Config**. 2. Click **{{< icon "plus" "v2" >}} Add Another Config**.
3. Complete steps 2-4 [above](#slack). 3. Complete steps 2-4 [above](#slack).
### SMTP ### SMTP

View File

@ -32,14 +32,14 @@ For more information, see [Configuring Chronograf](/chronograf/v1.9/administrati
## Build a dashboard ## Build a dashboard
1. #### Create a new dashboard 1. #### Create a new dashboard
Click **Dashboards** in the navigation bar and then click the **{{< icon "plus" >}} Create Dashboard** button. Click **Dashboards** in the navigation bar and then click the **{{< icon "plus" "v2" >}} Create Dashboard** button.
A new dashboard is created and ready to begin adding cells. A new dashboard is created and ready to begin adding cells.
2. #### Name your dashboard 2. #### Name your dashboard
Click **Name This Dashboard** and type a new name. For example, "ChronoDash". Click **Name This Dashboard** and type a new name. For example, "ChronoDash".
3. #### Enter cell editor mode 3. #### Enter cell editor mode
In the first cell, titled "Untitled Cell", click **{{< icon "plus" >}} Add Data** In the first cell, titled "Untitled Cell", click **{{< icon "plus" "v2" >}} Add Data**
to open the cell editor mode. to open the cell editor mode.
{{< img-hd src="/img/chronograf/1-9-dashboard-cell-add-data.png" alt="Add data to a Chronograf cell" />}} {{< img-hd src="/img/chronograf/1-9-dashboard-cell-add-data.png" alt="Add data to a Chronograf cell" />}}
@ -155,7 +155,7 @@ Select from a variety of dashboard templates to import and customize based on wh
### Full screen mode ### Full screen mode
View your dashboard in full screen mode by clicking on the full screen icon (**{{< icon "fullscreen" >}}**) in the top right corner of your dashboard. View your dashboard in full screen mode by clicking on the full screen icon (**{{< icon "fullscreen" "v2" >}}**) in the top right corner of your dashboard.
To exit full screen mode, press the Esc key. To exit full screen mode, press the Esc key.
### Template variables ### Template variables

View File

@ -19,7 +19,7 @@ Choose from the following methods:
## Upload line protocol through the Chronograf UI ## Upload line protocol through the Chronograf UI
1. Select **{{< icon "data-explorer" >}} Explore** in the left navigation bar. 1. Select **{{< icon "data-explorer" "v2" >}} Explore** in the left navigation bar.
2. Click **Write Data** in the top right corner of the Data Explorer. 2. Click **Write Data** in the top right corner of the Data Explorer.
{{< img-hd src="/img/chronograf/1-9-write-data.png" alt="Write data to InfluxDB with Chronograf" />}} {{< img-hd src="/img/chronograf/1-9-write-data.png" alt="Write data to InfluxDB with Chronograf" />}}
@ -53,7 +53,7 @@ To write data back to InfluxDB with an InfluxQL query, include the
[`INTO` clause](/{{< latest "influxdb" "v1" >}}/query_language/explore-data/#the-into-clause) [`INTO` clause](/{{< latest "influxdb" "v1" >}}/query_language/explore-data/#the-into-clause)
in your query: in your query:
1. Select **{{< icon "data-explorer" >}} Explore** in the left navigation bar. 1. Select **{{< icon "data-explorer" "v2" >}} Explore** in the left navigation bar.
2. Select **InfluxQL** as your data source type. 2. Select **InfluxQL** as your data source type.
3. Write an InfluxQL query that includes the `INTO` clause. Specify the database, 3. Write an InfluxQL query that includes the `INTO` clause. Specify the database,
retention policy, and measurement to write to. For example: retention policy, and measurement to write to. For example:
@ -80,7 +80,7 @@ To write data back to InfluxDB with an InfluxQL query, include the
[`INTO` clause](/{{< latest "influxdb" "v1" >}}/query_language/explore-data/#the-into-clause) [`INTO` clause](/{{< latest "influxdb" "v1" >}}/query_language/explore-data/#the-into-clause)
in your query: in your query:
1. Select **{{< icon "data-explorer" >}} Explore** in the left navigation bar. 1. Select **{{< icon "data-explorer" "v2" >}} Explore** in the left navigation bar.
2. Select **Flux** as your data source type. 2. Select **Flux** as your data source type.
{{% note %}} {{% note %}}

View File

@ -145,7 +145,7 @@ To alert when data stops flowing from InfluxDB OSS instances to your InfluxDB Cl
{{< nav-icon "alerts" >}} {{< nav-icon "alerts" >}}
2. Choose a InfluxDB OSS field or create a new OSS field for your deadman alert: 2. Choose a InfluxDB OSS field or create a new OSS field for your deadman alert:
1. Click **{{< icon "plus" >}} Create** and select **Deadman Check** in the dropown menu. 1. Click **{{< icon "plus" "v2" >}} Create** and select **Deadman Check** in the dropown menu.
2. Define your query with at least one field. 2. Define your query with at least one field.
3. Click **Submit** and **Configure Check**. 3. Click **Submit** and **Configure Check**.
When metrics stop reporting, you'll receive an alert. When metrics stop reporting, you'll receive an alert.
@ -164,7 +164,7 @@ InfluxDB Cloud supports different endpoints: Slack, PagerDuty, and HTTP. Slack i
#### Send a notification to Slack #### Send a notification to Slack
1. Create a [Slack Webhooks](https://api.slack.com/messaging/webhooks). 1. Create a [Slack Webhooks](https://api.slack.com/messaging/webhooks).
2. Go to **Alerts > Notification Endpoint** and click **{{< icon "plus" >}} Create**, and enter a name and description for your Slack endpoint. 2. Go to **Alerts > Notification Endpoint** and click **{{< icon "plus" "v2" >}} Create**, and enter a name and description for your Slack endpoint.
3. Enter your Slack Webhook under **Incoming Webhook URL** and click **Create Notification Endpoint**. 3. Enter your Slack Webhook under **Incoming Webhook URL** and click **Create Notification Endpoint**.
#### Send a notification to PagerDuty or HTTP #### Send a notification to PagerDuty or HTTP
@ -175,7 +175,7 @@ Send a notification to PagerDuty or HTTP endpoints (other webhooks) by [upgradin
[Create a notification rule](/influxdb/cloud/monitor-alert/notification-rules/create/) to set rules for when to send a deadman alert message to your notification endpoint. [Create a notification rule](/influxdb/cloud/monitor-alert/notification-rules/create/) to set rules for when to send a deadman alert message to your notification endpoint.
1. Go to **Alerts > Notification Rules** and click **{{< icon "plus" >}} Create**. 1. Go to **Alerts > Notification Rules** and click **{{< icon "plus" "v2" >}} Create**.
2. Fill out the **About** and **Conditions** section then click **Create Notification Rule**. 2. Fill out the **About** and **Conditions** section then click **Create Notification Rule**.
## Monitor with InfluxDB Insights and Aware ## Monitor with InfluxDB Insights and Aware

View File

@ -145,7 +145,7 @@ To alert when data stops flowing from InfluxDB OSS instances to your InfluxDB OS
{{< nav-icon "alerts" >}} {{< nav-icon "alerts" >}}
2. Choose a InfluxDB OSS field or create a new OSS field for your deadman alert: 2. Choose a InfluxDB OSS field or create a new OSS field for your deadman alert:
1. Click **{{< icon "plus" >}} Create** and select **Deadman Check** in the dropown menu. 1. Click **{{< icon "plus" "v2" >}} Create** and select **Deadman Check** in the dropown menu.
2. Define your query with at least one field. 2. Define your query with at least one field.
3. Click **Submit** and **Configure Check**. 3. Click **Submit** and **Configure Check**.
When metrics stop reporting, you'll receive an alert. When metrics stop reporting, you'll receive an alert.
@ -164,7 +164,7 @@ InfluxData supports different endpoints: Slack, PagerDuty, and HTTP. Slack is fr
#### Send a notification to Slack #### Send a notification to Slack
1. Create a [Slack Webhooks](https://api.slack.com/messaging/webhooks). 1. Create a [Slack Webhooks](https://api.slack.com/messaging/webhooks).
2. Go to **Alerts > Notification Endpoint** and click **{{< icon "plus" >}} Create**, and enter a name and description for your Slack endpoint. 2. Go to **Alerts > Notification Endpoint** and click **{{< icon "plus" "v2" >}} Create**, and enter a name and description for your Slack endpoint.
3. Enter your Slack Webhook under **Incoming Webhook URL** and click **Create Notification Endpoint**. 3. Enter your Slack Webhook under **Incoming Webhook URL** and click **Create Notification Endpoint**.
#### Send a notification to PagerDuty or HTTP #### Send a notification to PagerDuty or HTTP
@ -175,5 +175,5 @@ Send a notification to PagerDuty or HTTP endpoints (other webhooks) by [upgradin
[Create a notification rule](/influxdb/v2.0/monitor-alert/notification-rules/create/) to set rules for when to send a deadman alert message to your notification endpoint. [Create a notification rule](/influxdb/v2.0/monitor-alert/notification-rules/create/) to set rules for when to send a deadman alert message to your notification endpoint.
1. Go to **Alerts > Notification Rules** and click **{{< icon "plus" >}} Create**. 1. Go to **Alerts > Notification Rules** and click **{{< icon "plus" "v2" >}} Create**.
2. Fill out the **About** and **Conditions** section then click **Create Notification Rule**. 2. Fill out the **About** and **Conditions** section then click **Create Notification Rule**.

View File

@ -29,29 +29,29 @@ The following pushdowns are supported in InfluxDB Enterprise 1.9+.
| Functions | Supported | | Functions | Supported |
| :----------------------------- | :------------------: | | :----------------------------- | :------------------: |
| **count()** | {{< icon "check" >}} | | **count()** | {{< icon "check" "v2" >}} |
| **drop()** | {{< icon "check" >}} | | **drop()** | {{< icon "check" "v2" >}} |
| **duplicate()** | {{< icon "check" >}} | | **duplicate()** | {{< icon "check" "v2" >}} |
| **filter()** {{% req " \*" %}} | {{< icon "check" >}} | | **filter()** {{% req " \*" %}} | {{< icon "check" "v2" >}} |
| **fill()** | {{< icon "check" >}} | | **fill()** | {{< icon "check" "v2" >}} |
| **first()** | {{< icon "check" >}} | | **first()** | {{< icon "check" "v2" >}} |
| **group()** | {{< icon "check" >}} | | **group()** | {{< icon "check" "v2" >}} |
| **keep()** | {{< icon "check" >}} | | **keep()** | {{< icon "check" "v2" >}} |
| **last()** | {{< icon "check" >}} | | **last()** | {{< icon "check" "v2" >}} |
| **max()** | {{< icon "check" >}} | | **max()** | {{< icon "check" "v2" >}} |
| **mean()** | {{< icon "check" >}} | | **mean()** | {{< icon "check" "v2" >}} |
| **min()** | {{< icon "check" >}} | | **min()** | {{< icon "check" "v2" >}} |
| **range()** | {{< icon "check" >}} | | **range()** | {{< icon "check" "v2" >}} |
| **rename()** | {{< icon "check" >}} | | **rename()** | {{< icon "check" "v2" >}} |
| **sum()** | {{< icon "check" >}} | | **sum()** | {{< icon "check" "v2" >}} |
| **window()** | {{< icon "check" >}} | | **window()** | {{< icon "check" "v2" >}} |
| _Function combinations_ | | | _Function combinations_ | |
| **window()** \|> **count()** | {{< icon "check" >}} | | **window()** \|> **count()** | {{< icon "check" "v2" >}} |
| **window()** \|> **first()** | {{< icon "check" >}} | | **window()** \|> **first()** | {{< icon "check" "v2" >}} |
| **window()** \|> **last()** | {{< icon "check" >}} | | **window()** \|> **last()** | {{< icon "check" "v2" >}} |
| **window()** \|> **max()** | {{< icon "check" >}} | | **window()** \|> **max()** | {{< icon "check" "v2" >}} |
| **window()** \|> **min()** | {{< icon "check" >}} | | **window()** \|> **min()** | {{< icon "check" "v2" >}} |
| **window()** \|> **sum()** | {{< icon "check" >}} | | **window()** \|> **sum()** | {{< icon "check" "v2" >}} |
{{% caption %}} {{% caption %}}
{{< req "\*" >}} **filter()** only pushes down when all parameter values are static. {{< req "\*" >}} **filter()** only pushes down when all parameter values are static.

View File

@ -10,7 +10,7 @@ related:
products: [cloud, oss, enterprise] products: [cloud, oss, enterprise]
--- ---
This is a paragraph. Lorem ipsum dolor ({{< icon "trash" >}}) sit amet, consectetur adipiscing elit. Nunc rutrum, metus id scelerisque euismod, erat ante suscipit nibh, ac congue enim risus id est. Etiam tristique nisi et tristique auctor. Morbi eu bibendum erat. Sed ullamcorper, dui id lobortis efficitur, mauris odio pharetra neque, vel tempor odio dolor blandit justo. This is a paragraph. Lorem ipsum dolor ({{< icon "trash" "v2" >}}) sit amet, consectetur adipiscing elit. Nunc rutrum, metus id scelerisque euismod, erat ante suscipit nibh, ac congue enim risus id est. Etiam tristique nisi et tristique auctor. Morbi eu bibendum erat. Sed ullamcorper, dui id lobortis efficitur, mauris odio pharetra neque, vel tempor odio dolor blandit justo.
[Ref link][foo] [Ref link][foo]
@ -18,10 +18,83 @@ This is a paragraph. Lorem ipsum dolor ({{< icon "trash" >}}) sit amet, consecte
This is **bold** text. This is _italic_ text. This is _**bold and italic**_. This is **bold** text. This is _italic_ text. This is _**bold and italic**_.
{{< nav-icon "account" "v2" >}}
{{< nav-icon "data" "v2" >}}
{{< nav-icon "explore" "v2" >}}
{{< nav-icon "org" "v2" >}}
{{< nav-icon "boards" "v2" >}}
{{< nav-icon "tasks" "v2" >}}
{{< nav-icon "alerts" "v2" >}}
{{< nav-icon "settings" "v2" >}}
{{< nav-icon "notebooks" "v2" >}}
{{< icon "add-cell" "v2" >}} add-cell
{{< icon "add-label" "v2" >}} add-label
{{< icon "alert" "v2" >}} alert
{{< icon "calendar" "v2" >}} calendar
{{< icon "chat" "v2" >}} chat
{{< icon "checkmark" "v2" >}} checkmark
{{< icon "clone" "v2" >}} clone
{{< icon "cloud" "v2" >}} cloud
{{< icon "cog" "v2" >}} cog
{{< icon "config" "v2" >}} config
{{< icon "copy" "v2" >}} copy
{{< icon "crown" "v2" >}} crown
{{< icon "dashboard" "v2" >}} dashboard
{{< icon "dashboards" "v2" >}} dashboards
{{< icon "data-explorer" "v2" >}} data-explorer
{{< icon "delete" "v2" >}} delete
{{< icon "download" "v2" >}} download
{{< icon "duplicate" "v2" >}} duplicate
{{< icon "edit" "v2" >}} edit
{{< icon "expand" "v2" >}} expand
{{< icon "export" "v2" >}} export
{{< icon "eye" "v2" >}} eye
{{< icon "eye-closed" "v2" >}} eye-closed
{{< icon "eye-open" "v2" >}} eye-open
{{< icon "feedback" "v2" >}} feedback
{{< icon "fullscreen" "v2" >}} fullscreen
{{< icon "gear" "v2" >}} gear
{{< icon "graph" "v2" >}} graph
{{< icon "hide" "v2" >}} hide
{{< icon "influx" "v2" >}} influx
{{< icon "influx-icon" "v2" >}} influx-icon
{{< icon "nav-admin" "v2" >}} nav-admin
{{< icon "nav-config" "v2" >}} nav-config
{{< icon "nav-configuration" "v2" >}} nav-configuration
{{< icon "nav-dashboards" "v2" >}} nav-dashboards
{{< icon "nav-data-explorer" "v2" >}} nav-data-explorer
{{< icon "nav-organizations" "v2" >}} nav-organizations
{{< icon "nav-orgs" "v2" >}} nav-orgs
{{< icon "nav-tasks" "v2" >}} nav-tasks
{{< icon "note" "v2" >}} note
{{< icon "notebook" "v2" >}} notebook
{{< icon "notebooks" "v2" >}} notebooks
{{< icon "org" "v2" >}} org
{{< icon "orgs" "v2" >}} orgs
{{< icon "pause" "v2" >}} pause
{{< icon "pencil" "v2" >}} pencil
{{< icon "play" "v2" >}} play
{{< icon "plus" "v2" >}} plus
{{< icon "refresh" "v2" >}} refresh
{{< icon "remove" "v2" >}} remove
{{< icon "replay" "v2" >}} replay
{{< icon "save-as" "v2" >}} save-as
{{< icon "search" "v2" >}} search
{{< icon "settings" "v2" >}} settings
{{< icon "tasks" "v2" >}} tasks
{{< icon "toggle" "v2" >}} toggle
{{< icon "trash" "v2" >}} trash
{{< icon "trashcan" "v2" >}} trashcan
{{< icon "triangle" "v2" >}} triangle
{{< icon "view" "v2" >}} view
{{< icon "wrench" "v2" >}} wrench
{{< icon "x" "v2" >}} x
### Clockface 3.x icons
{{< nav-icon "account" >}} {{< nav-icon "account" >}}
{{< nav-icon "data" >}} {{< nav-icon "data" >}}
{{< nav-icon "explore" >}} {{< nav-icon "explore" >}}
{{< nav-icon "org" >}}
{{< nav-icon "boards" >}} {{< nav-icon "boards" >}}
{{< nav-icon "tasks" >}} {{< nav-icon "tasks" >}}
{{< nav-icon "alerts" >}} {{< nav-icon "alerts" >}}
@ -31,9 +104,13 @@ This is **bold** text. This is _italic_ text. This is _**bold and italic**_.
{{< icon "add-cell" >}} add-cell {{< icon "add-cell" >}} add-cell
{{< icon "add-label" >}} add-label {{< icon "add-label" >}} add-label
{{< icon "alert" >}} alert {{< icon "alert" >}} alert
{{< icon "annotate" >}} annotate
{{< icon "bar-chart" >}} bar-chart
{{< icon "bar-graph" >}} bar-graph
{{< icon "calendar" >}} calendar {{< icon "calendar" >}} calendar
{{< icon "chat" >}} chat {{< icon "chat" >}} chat
{{< icon "checkmark" >}} checkmark {{< icon "checkmark" >}} checkmark
{{< icon "clock" >}} clock
{{< icon "clone" >}} clone {{< icon "clone" >}} clone
{{< icon "cloud" >}} cloud {{< icon "cloud" >}} cloud
{{< icon "cog" >}} cog {{< icon "cog" >}} cog
@ -56,9 +133,12 @@ This is **bold** text. This is _italic_ text. This is _**bold and italic**_.
{{< icon "fullscreen" >}} fullscreen {{< icon "fullscreen" >}} fullscreen
{{< icon "gear" >}} gear {{< icon "gear" >}} gear
{{< icon "graph" >}} graph {{< icon "graph" >}} graph
{{< icon "handle" >}} handle
{{< icon "hide" >}} hide {{< icon "hide" >}} hide
{{< icon "influx" >}} influx {{< icon "influx" >}} influx
{{< icon "influx-icon" >}} influx-icon {{< icon "influx-icon" >}} influx-icon
{{< icon "move" >}} move
{{< icon "move-cell" >}} move-cell
{{< icon "nav-admin" >}} nav-admin {{< icon "nav-admin" >}} nav-admin
{{< icon "nav-config" >}} nav-config {{< icon "nav-config" >}} nav-config
{{< icon "nav-configuration" >}} nav-configuration {{< icon "nav-configuration" >}} nav-configuration
@ -74,6 +154,7 @@ This is **bold** text. This is _italic_ text. This is _**bold and italic**_.
{{< icon "orgs" >}} orgs {{< icon "orgs" >}} orgs
{{< icon "pause" >}} pause {{< icon "pause" >}} pause
{{< icon "pencil" >}} pencil {{< icon "pencil" >}} pencil
{{< icon "pin" >}} pin
{{< icon "play" >}} play {{< icon "play" >}} play
{{< icon "plus" >}} plus {{< icon "plus" >}} plus
{{< icon "refresh" >}} refresh {{< icon "refresh" >}} refresh
@ -771,3 +852,29 @@ This is truncated content.
This is truncated content. This is truncated content.
This is truncated content. This is truncated content.
{{% /truncate %}} {{% /truncate %}}
{{< tabs-wrapper >}}
{{% tabs "small" %}}
[Small tab 2.1](#)
[Small tab 2.2](#)
[Small tab 2.3](#)
[Small tab 2.4](#)
{{% /tabs %}}
{{% tab-content %}}
This is small tab 2.1 content.
{{% /tab-content %}}
{{% tab-content %}}
This is small tab 2.2 content.
{{% /tab-content %}}
{{% tab-content %}}
This is small tab 2.3 content.
{{% /tab-content %}}
{{% tab-content %}}
This is small tab 2.4 content.
{{% /tab-content %}}
{{< /tabs-wrapper >}}

View File

@ -28,7 +28,7 @@ The `tripleEMA()` function calculates the exponential moving average of values i
the `_value` column grouped into `n` number of points, giving more weight to recent the `_value` column grouped into `n` number of points, giving more weight to recent
data with less lag than data with less lag than
[`exponentialMovingAverage()`](/flux/v0.x/stdlib/universe/exponentialmovingaverage/) [`exponentialMovingAverage()`](/flux/v0.x/stdlib/universe/exponentialmovingaverage/)
and [`doubleEMA()`](http://localhost:1313/influxdb/v2.0/reference/flux/stdlib/built-in/transformations/doubleema/). and [`doubleEMA()`](/flux/v0.x/stdlib/universe/doubleema/).
```js ```js
tripleEMA(n: 5) tripleEMA(n: 5)

View File

@ -18,8 +18,10 @@ After you've [signed up for InfluxDB Cloud](/influxdb/cloud/sign-up/), you're re
- Add [sample data](#add-sample-data). - Add [sample data](#add-sample-data).
- [Use your own data](/influxdb/cloud/write-data/) to explore InfluxDB Cloud. - [Use your own data](/influxdb/cloud/write-data/) to explore InfluxDB Cloud.
2. [Create a notebook](#create-a-notebook): 2. [Create a notebook](#create-a-notebook):
1. Clicking **Books > Create Notebook** in the navigation menu on the left. 1. Clicking **Notebooks** in the navigation menu on the left.
{{< nav-icon "books" >}} {{< nav-icon "books" >}}
2. [Select metrics](#select-metrics) 2. [Select metrics](#select-metrics)
3. [Visualize data](#visualize-data) 3. [Visualize data](#visualize-data)
4. (Optional) [Process data](#process-data) 4. (Optional) [Process data](#process-data)
@ -30,11 +32,11 @@ After you've [signed up for InfluxDB Cloud](/influxdb/cloud/sign-up/), you're re
This example uses InfluxDB Cloud's Website Monitoring demo data bucket. To add the demo data bucket: This example uses InfluxDB Cloud's Website Monitoring demo data bucket. To add the demo data bucket:
1. Click **Data (Load Data)** > **Buckets** in the navigation menu on the left. 1. Click **Load Data** > **Buckets** in the navigation menu on the left.
{{< nav-icon "data" >}} {{< nav-icon "data" >}}
2. Click **{{< icon "plus" >}} Add Demo Data**, and then select the **Website Monitoring** bucket. 2. Click **{{< icon "plus" >}} {{< caps >}}Add Demo Data{{< /caps >}}**, and then select the **Website Monitoring** bucket.
3. The Demo Data bucket appears in your list of buckets. 3. The Demo Data bucket appears in your list of buckets.
## Add sample data ## Add sample data

View File

@ -9,8 +9,4 @@ menu:
weight: 6 weight: 6
--- ---
Notebooks are a way to build and annotate processes and data flows for time series data. Notebooks include cells and controls to transform the data in your bucket and other countless possibilities. {{< duplicate-oss >}}
To learn how to use notebooks, check out the following articles:
{{< children >}}

View File

@ -10,31 +10,4 @@ menu:
parent: Notebooks parent: Notebooks
--- ---
Learn how to create a notebook that normalizes data. Walk through the following example to create a notebook that does the following: {{< duplicate-oss >}}
- Inputs sample data from NOAA
- Normalizes sample data with a Flux script
- Outputs normalized data to a bucket
## Requirements
- This example uses [NOAA water database data](/influxdb/v2.0/reference/sample-data/#noaa-water-sample-data). Note that using this data counts towards your total usage.
- Create a destination bucket to write normalized data to. For details, see [Create a bucket](/influxdb/cloud/organizations/buckets/create-bucket/).
## Normalize data with a notebook
1. Create a new notebook (see [Create a notebook](/influxdb/cloud/notebooks/create-notebook/)).
2. Add a **Metric Selector** cell to select a bucket to query data from:
- In the **Choose a bucket** dropdown, select your NOAA bucket.
- Select the **h2o_temperature** field.
- Select the **mean** function from the aggregate selector in the upper-right.
3. Add a **Flux Transformation** cell with the following script to bring in data from the previous cell and normalize it:
```sh
__PREVIOUS_RESULT__
|> map(fn: (r) => ({ r with _value: float(v: r._value) / 10.0 }))
```
4. Add an **Output to Bucket** cell:
- Select the destination bucket for your normalized data.
5. Add a **Markdown** cell to add a note to your team about what this notebook does. For example, the cell might say, "This notebook makes `h20_temperature` easier to view alongside `water_level`."
5. Click **Preview** in the upper left to verify that your notebook runs and preview the output.
6. Run your notebook:
- Click **Run** to run the notebook and write to the output bucket a single time.
- To write continuously, click **Export as Task** in the upper right corner of the **Output to Bucket** cell. For details about working with tasks, see [Manage tasks](/influxdb/cloud/process-data/manage-tasks/).

View File

@ -9,105 +9,4 @@ menu:
name: Create a notebook name: Create a notebook
parent: Notebooks parent: Notebooks
--- ---
To learn how notebooks can be useful and to see an overview of different cell types available in notebooks, see [Overview of Notebooks](/influxdb/cloud/notebooks/overview/). {{< duplicate-oss >}}
1. In the navigation menu on the left, click **Notebooks**.
{{< nav-icon "notebooks" >}}
2. Click **+Create Notebook**, and then enter a name for your notebook in the **Name this notebook** field. By default, the notebook name appears as `<username>-notebook-<year>-<month>-<day and time>`.
3. Do the following at the top of the page:
- Select your local time zone or UTC.
- Choose a time range for your data.
4. Consider which notebook cells to add to your notebook. You need to have one input cell for other cells to run properly. By default, each notebook includes **Metric Selector**, **Data Validation**, and **Visualization** cells.
5. Select your bucket in **Metric Selector** and then select the filters to narrow your data.
6. Do one of the following:
- To view results in your cells (for example, **Data Validation** and **Visualization**) *without writing data*, click **Preview** (or press **CTRL + Enter**).
- To view the results of each cell and write the results to the specified output bucket, click **Run**.
7. (Optional) Change your visualization settings with the dropdown menus and gear icon at the top of the **Visualization** cell.
8. (Optional) Click the **+** icon, and then add one or more of the following cell types to your notebook:
- [Input](#add-an-input-cell): to pull information into your notebook
- [Transform](#add-a-transform-cell): to filter and apply changes to your data
- [Pass-through](#add-a-pass-through-cell): to visualize and add notes to your data
- [Output](#add-an-output-cell): to write data to a bucket, preview output before writing, or schedule an output task
9. (Optional) [Convert a cell into raw Flux script](#view-and-edit-flux-script-in-a-cell) to view and edit the code.
### Add an input cell
1. Select **Metric Builder** or **Query Builder** as your input, and then select the bucket to pull data from.
2. Select filters to narrow your data.
3. Select **Preview** (**CTRL + Enter**) or **Run** in the upper left dropdown menu.
### Add a transform cell
1. Select one of the following transform cell-types:
- **Flux Script**: Use `__PREVIOUS_RESULT__` to build from data in the previous cell, enter a Flux script to transform your data.
- **Downsample**: Window data by time and apply an aggregate to each window to downsample data. For more information, see [Downsample data with notebooks](/influxdb/cloud/notebooks/downsample/).
2. Select **Preview** (**CTRL + Enter**) or **Run** in the upper left dropdown menu.
{{% warn %}}
If your cell contains a custom script that uses any output function to write data to InfluxDB (for example: the to() function) or send it to a third party service, clicking Preview will write data.
{{% /warn %}}
### Add a pass-through cell
Select one of the following pass-through cell-types:
- To change visability and name of columns, select [Column Editor](#column-editor).
- To create a visualization of your data, select [Visualization](#visualization). For details on available visualization types and how to use them, see [Visualization types](/influxdb/cloud/visualize-data/visualization-types/).
- To enter explanatory notes, select [Markdown](#markdown).
#### Column Editor
- Click the toggle to hide or view your column.
- Rename your columns by hovering over the column name and pressing the pencil icon.
#### Visualization
- To change your visualization type, click the second dropdown menu at the top of the cell.
- (For histogram only) To specify values, click **Select**.
- To configure the visualization, click **Configure**.
- To download results as an annotated CSV file, click the **CSV** button.
- To export to the dashboard, click **Export to Dashboard**.
#### Markdown
- Type in notes as needed.
### Add an output cell
Select one of the following output cell-types:
- To recieve a notification, select [Alert](#alert) and complete the steps below.
- To write output to a bucket, select [Output to Bucket](#output-to-bucket) and complete the steps below.
- To create a task, select [Schedule](#schedule) and complete the steps below.
#### Alert
1. Enter a time range to automatically check the data and enter your query offset.
2. Customize the conditions to send an alert.
3. Select an endpoint to receive an alert:
- Slack and a Slack Channel
- HTTP post
- Pager Duty
4. (Optional) Personalize your message. By default, the message is "${strings.title(v: r._type)} for ${r._source_measurement} triggered at ${time(v: r._source_timestamp)}!"
5. Click **Export as Task** to create your alarm.
#### Output to bucket
1. Select a bucket.
2. Click **Preview** to see what would be written to the bucket without commiting, or click **Run** in the upper left to write, or select **Export as Task** to schedule your output as a task.
#### Schedule
1. Enter a time and an offset to schedule the task.
2. Click **Export as Task** to save.
### View and edit Flux script in a cell
Convert your notebook cells into raw Flux script to view and edit the code. Conversion to Flux is available for the following cell types:
- **Inputs: Metric Selector**
- **Transform: Column Editor** and **Downsample**
1. Click the overflow menu icon in the cell you want to view as Flux, and then select **Convert to |> Flux**. You won't be able to undo this step.
A Flux cell appears with underlying script for the selected cell.
3. View and edit the Flux script as needed.

View File

@ -9,21 +9,4 @@ menu:
parent: Notebooks parent: Notebooks
--- ---
View, update, and delete notebooks in the UI. {{< duplicate-oss >}}
## View or update notebooks
1. In the navigation menu on the left, click **Notebooks**.
{{< nav-icon "notebooks" >}}
A list of notebooks appears.
2. Click a notebook to open it.
3. To update, edit the notebook's cells and content. Changes are saved automatically.
## Delete a notebook
1. In the navigation menu on the left, click **Notebooks**.
{{< nav-icon "notebooks" >}}
2. Hover over a notebook in the list that appears.
3. Click **Delete Notebook**.
4. Click **Confirm**.

View File

@ -10,76 +10,4 @@ menu:
parent: Notebooks parent: Notebooks
--- ---
Learn about the building blocks of a notebook, how notebooks can help show how data is processed, and discover some common use cases. {{< duplicate-oss >}}
To use different notebook cell types, controls, and uses to process data, see:
- [Notebook concepts](/influxdb/cloud/notebooks/overview/#notebook-concepts)
- [Notebook controls](/influxdb/cloud/notebooks/overview/#notebook-controls)
- [Notebook cell types](/influxdb/cloud/notebooks/overview/#notebook-cell-types)
## Notebook concepts
{{< youtube Rs16uhxK0h8 >}}
Using notebooks, you can:
- Create documents with live code, equations, visualizations, and explanatory notes.
- Create dashboard cells or scheduled tasks.
- Clean and downsample data.
- Build runbooks.
- Document data processing steps.
## Notebook controls
The following options appear at the top of each notebook.
### Preview/Run mode
- Select **Preview** (or press **Control+Enter**) to display results of each cell without writing data. Helps to verify that cells return expected results before writing data.
- Select **Run** mode displays results of each cell and writes data to the selected bucket.
### Presentation mode
Display notebooks in full screen with Presentation mode, hiding the left and top navigation menus so only the cells appear. This mode might be helpful, for example, for stationary screens dedicated to monitoring visualizations.
### Local or UTC timezone
Click the timezone dropdown list to select a timezone to use for the dashboard. Select either the local time (default) or UTC.
### Time range
Select from the options in the dropdown list or select **Custom Time Range** to enter a custom time range with precision up to nanoseconds.
## Notebook cell types
The following cell types are available for your notebook:
- [Inputs](#inputs)
- [Transform](#transform)
- [Pass-through](#pass-through)
- [Output](#output)
### Inputs
At least one input cell is required in a notebook for other cells to run.
- **Metric Selector**: Filter out your data using a single list.
- **Query Builder**: Filter out your data using lists separated by group keys.
### Transform
- **Flux Script**:
Modify your data with Flux Script. `__PREVIOUS_RESULT__` refers to your previous inputs from the Metric Selector.
- **Downsample**:
Downsample data through aggregates.
### Pass-through
- **Column Editor**: Modify column visibility and naming.
- **Markdown**: Create explanatory notes or other information for yourself or one of your team members.
- **Visualization**: Represents your data in visual formats such as graphs or charts.
### Output
- **Notification**: Set up alerts.
- **Output to Bucket**: In **Preview** mode, this cell represents what would be written if the data was going to be committed to a bucket.
- **Output: Schedule**: Run tasks at specific times.

View File

@ -9,11 +9,4 @@ menu:
parent: Notebooks parent: Notebooks
--- ---
### No measurements appear in my bucket even though there's data in it. {{< duplicate-oss >}}
Try changing the time range. You might have measurements prior to the time range you selected. For example, if the selected time range is `Past 1h` and the last write happened 16 hours ago, you'd need to change the time range to `Past 24h` (or more) to see your data.
### "No bucket exists" error message appears.
This error appears when the Buckets API endpoint returns a list of bucket and you dont have access to that bucket. Verify that you have access permissions to the bucket that you're trying to query or write to.
### Metric selector crashes.
This can occur with high-cardinality buckets when there's too much data for the browser. To decrease the amount of data in your bucket, see how to [resolve high series cardinality](/influxdb/cloud/write-data/best-practices/resolve-high-cardinality/).

View File

@ -42,7 +42,7 @@ token to InfluxDB.
##### Syntax ##### Syntax
```sh ```sh
Authorization: Token <token> Authorization: Token INFLUXDB_API_TOKEN
``` ```
##### Example ##### Example
@ -85,7 +85,7 @@ Use the `Authorization` header with the `Basic` scheme to provide username and p
##### Syntax ##### Syntax
```sh ```sh
Authorization: Basic <username>:<password> Authorization: Basic INFLUX_USERNAME:INFLUX_API_TOKEN
``` ```
##### Example ##### Example
@ -97,9 +97,10 @@ Authorization: Basic <username>:<password>
{{% /code-tabs %}} {{% /code-tabs %}}
{{% code-tab-content %}} {{% code-tab-content %}}
```sh ```sh
{{% get-shared-text "api/v1-compat/auth/oss/basic-auth.sh" %}} {{% get-shared-text "api/v1-compat/auth/cloud/basic-auth.sh" %}}
``` ```
{{% /code-tab-content %}} {{% /code-tab-content %}}
{{% code-tab-content %}} {{% code-tab-content %}}
```js ```js
{{% get-shared-text "api/v1-compat/auth/cloud/basic-auth.js" %}} {{% get-shared-text "api/v1-compat/auth/cloud/basic-auth.js" %}}
@ -107,6 +108,10 @@ Authorization: Basic <username>:<password>
{{% /code-tab-content %}} {{% /code-tab-content %}}
{{< /code-tabs-wrapper >}} {{< /code-tabs-wrapper >}}
Replace the following:
- *`exampleuser@influxdata.com`*: the email address that you signed up with
- *`INFLUX_API_TOKEN`*: your [InfluxDB API token](/influxdb/cloud/reference/glossary/#token)
#### Query string authentication #### Query string authentication
Use InfluxDB 1.x API parameters to provide username and password credentials through the query string. Use InfluxDB 1.x API parameters to provide username and password credentials through the query string.
@ -120,8 +125,8 @@ Use InfluxDB 1.x API parameters to provide username and password credentials thr
##### Syntax ##### Syntax
```sh ```sh
/query/?u=<username>&p=<password> /query/?u=INFLUX_USERNAME&p=INFLUX_API_TOKEN
/write/?u=<username>&p=<password> /write/?u=INFLUX_USERNAME&p=INFLUX_API_TOKEN
``` ```
##### Example ##### Example
@ -133,16 +138,20 @@ Use InfluxDB 1.x API parameters to provide username and password credentials thr
{{% /code-tabs %}} {{% /code-tabs %}}
{{% code-tab-content %}} {{% code-tab-content %}}
```sh ```sh
{{% get-shared-text "api/v1-compat/auth/oss/querystring-auth.sh" %}} {{% get-shared-text "api/v1-compat/auth/cloud/querystring-auth.sh" %}}
``` ```
{{% /code-tab-content %}} {{% /code-tab-content %}}
{{% code-tab-content %}} {{% code-tab-content %}}
```js ```js
{{% get-shared-text "api/v1-compat/auth/oss/querystring-auth.js" %}} {{% get-shared-text "api/v1-compat/auth/cloud/querystring-auth.js" %}}
``` ```
{{% /code-tab-content %}} {{% /code-tab-content %}}
{{< /code-tabs-wrapper >}} {{< /code-tabs-wrapper >}}
Replace the following:
- *`exampleuser@influxdata.com`*: the email address that you signed up with
- *`INFLUX_API_TOKEN`*: your [InfluxDB API token](/influxdb/cloud/reference/glossary/#token)
## InfluxQL support ## InfluxQL support
The compatibility API supports InfluxQL, with the following caveats: The compatibility API supports InfluxQL, with the following caveats:

View File

@ -10,109 +10,8 @@ menu:
parent: Command line tools parent: Command line tools
weight: 101 weight: 101
influxdb/cloud/tags: [cli] influxdb/cloud/tags: [cli]
related:
- /influxdb/cloud/tools/clis/
--- ---
The `influx` command line interface (CLI) includes commands to manage many aspects of InfluxDB, {{< duplicate-oss >}}
including buckets, organizations, users, tasks, etc.
For information about setting up and configuring the `influx` CLI, see [Download, install, and use the influx CLI](/influxdb/cloud/sign-up/#optional-download-install-and-use-the-influx-cli).
## Usage
```
influx [flags]
influx [command]
```
### Provide required authentication credentials
To avoid having to pass your InfluxDB **host**, **API token**, and **organization**
with each command, store them in an `influx` CLI configuration (config).
`influx` commands that require these credentials automatically retrieve these
credentials from the active config.
Use the [`influx config create` command](/influxdb/cloud/reference/cli/influx/config/create/)
to create an `influx` CLI config and set it as active:
```sh
influx config create --config-name <config-name> \
--host-url http://localhost:8086 \
--org <your-org> \
--token <your-api-token> \
--active
```
For more information about managing CLI configurations, see the
[`influx config` documentation](/influxdb/cloud/reference/cli/influx/config/).
## Commands
| Command | Description |
|:------- |:----------- |
| [apply](/influxdb/cloud/reference/cli/influx/apply) | Apply an InfluxDB template |
| [auth](/influxdb/cloud/reference/cli/influx/auth) | API token management commands |
| [backup](/influxdb/cloud/reference/cli/influx/backup) | Back up data |
| [bucket](/influxdb/cloud/reference/cli/influx/bucket) | Bucket management commands |
| [completion](/influxdb/cloud/reference/cli/influx/completion) | Generate completion scripts |
| [config](/influxdb/cloud/reference/cli/influx/config) | Configuration management commands |
| [dashboards](/influxdb/cloud/reference/cli/influx/dashboards) | List dashboards |
| [delete](/influxdb/cloud/reference/cli/influx/delete) | Delete points from InfluxDB |
| [export](/influxdb/cloud/reference/cli/influx/export) | Export resources as a template |
| [help](/influxdb/cloud/reference/cli/influx/help) | Help about any command |
| [org](/influxdb/cloud/reference/cli/influx/org) | Organization management commands |
| [ping](/influxdb/cloud/reference/cli/influx/ping) | Check the InfluxDB `/health` endpoint |
| [query](/influxdb/cloud/reference/cli/influx/query) | Execute a Flux query |
| [secret](/influxdb/cloud/reference/cli/influx/secret) | Manage secrets |
| [setup](/influxdb/cloud/reference/cli/influx/setup) | Create default username, password, org, bucket, etc. |
| [stacks](/influxdb/cloud/reference/cli/influx/stacks) | Manage InfluxDB stacks |
| [task](/influxdb/cloud/reference/cli/influx/task) | Task management commands |
| [telegrafs](/influxdb/cloud/reference/cli/influx/telegrafs) | Telegraf configuration management commands |
| [template](/influxdb/cloud/reference/cli/influx/template) | Summarize and validate an InfluxDB template |
| [user](/influxdb/cloud/reference/cli/influx/user) | User management commands |
| [v1](/influxdb/cloud/reference/cli/influx/v1) | Work with the v1 compatibility API |
| [version](/influxdb/cloud/reference/cli/influx/version) | Print the influx CLI version |
| [write](/influxdb/cloud/reference/cli/influx/write) | Write points to InfluxDB |
## Flags
| Flag | | Description |
|:---- |:--- |:----------- |
| `-h` | `--help` | Help for the `influx` command |
| | `--http-debug` | Inspect communication with InfluxDB servers |
### Flag patterns and conventions
The `influx` CLI uses the following patterns and conventions:
- [Mapped environment variables](#mapped-environment-variables)
- [Shorthand and longhand flags](#shorthand-and-longhand-flags)
- [Flag input types](#flag-input-types)
#### Mapped environment variables
`influx` CLI flags mapped to environment variables are listed in the **Mapped to** column.
Mapped flags inherit the value of the environment variable.
To override environment variables, set the flag explicitly in your command.
#### Shorthand and longhand flags
Many `influx` CLI flags support both shorthand and longhand forms.
- **shorthand:** a shorthand flag begins with a single hyphen followed by a single letter (for example: `-c`).
- **longhand:** a longhand flag starts with two hyphens followed by a multi-letter,
hyphen-spaced flag name (for example: `--active-config`).
Commands can use both shorthand and longhand flags in a single execution.
#### Flag input types
`influx` CLI flag input types are listed in each the table of flags for each command.
Flags support the following input types:
##### string
Text string, but the flag can be used **only once** per command execution.
##### stringArray
Single text string, but the flag can be used **multiple times** per command execution.
##### integer
Sequence of digits representing an integer value.
##### duration
Length of time represented by an integer and a duration unit
(`1ns`, `1us`, `1µs`, `1ms`, `1s`, `1m`, `1h`, `1d`, `1w`).

View File

@ -12,6 +12,7 @@ influxdb/cloud/tags: [templates]
related: related:
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
metadata: [influx CLI 2.0.0+]
--- ---
{{< duplicate-oss >}} {{< duplicate-oss >}}

View File

@ -11,6 +11,7 @@ cascade:
related: related:
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
metadata: [influx CLI 2.0.0+]
--- ---
{{< duplicate-oss >}} {{< duplicate-oss >}}

View File

@ -6,6 +6,7 @@ menu:
name: influx auth create name: influx auth create
parent: influx auth parent: influx auth
weight: 201 weight: 201
updated_in: CLI v2.2.0
--- ---
{{< duplicate-oss >}} {{< duplicate-oss >}}

View File

@ -10,13 +10,15 @@ influxdb/cloud/tags: [backup]
related: related:
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
metadata: [influx CLI 2.0.0+, InfluxDB OSS only]
updated_in: CLI v2.0.2
--- ---
{{% note %}} {{% note %}}
#### Available with InfluxDB OSS 2.x only #### Works with InfluxDB OSS 2.x
The `influx backup` command works with **InfluxDB OSS 2.x**, but does not work with **InfluxDB Cloud**. The `influx backup` command works with **InfluxDB OSS 2.x**, but does not work with **InfluxDB Cloud**.
For information about backing up data in InfluxDB Cloud, see For information about backing up data in InfluxDB Cloud, see
[InfluxDB Cloud durabilty](/influxdb/cloud/reference/internals/durability/) or [InfluxDB Cloud durability](/influxdb/cloud/reference/internals/durability/) or
[contact InfluxData Support](mailto:support@influxdata.com). [contact InfluxData Support](mailto:support@influxdata.com).
{{% /note %}} {{% /note %}}

View File

@ -13,28 +13,7 @@ cascade:
- /influxdb/cloud/organizations/buckets/ - /influxdb/cloud/organizations/buckets/
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
metadata: [influx CLI 2.1.0+]
--- ---
The `influx bucket-schema` command and its subcommands manage {{< duplicate-oss >}}
schemas for InfluxDB buckets.
## Usage
```
influx bucket-schema [flags]
influx bucket-schema [command]
```
## Subcommands
| Subcommand | Description |
|:---------- |:----------- |
| [create](/influxdb/cloud/reference/cli/influx/bucket-schema/create) | Create a bucket schema |
| [list](/influxdb/cloud/reference/cli/influx/bucket-schema/list) | List bucket schemas |
| [update](/influxdb/cloud/reference/cli/influx/bucket-schema/update) | Update a bucket schema |
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:---------- |:------------------ |
| `-h` | `--help` | Help for the `bucket-schema` command | | |

View File

@ -10,80 +10,4 @@ related:
- /influxdb/cloud/organizations/buckets/bucket-schema - /influxdb/cloud/organizations/buckets/bucket-schema
--- ---
The `influx bucket-schema create` command sets the schema for a measurement in an InfluxDB bucket that has the [`explicit` schema-type](/influxdb/cloud/reference/cli/influx/bucket/create/#create-a-bucket-with-an-explicit-schema). {{< duplicate-oss >}}
## Usage
```sh
influx bucket-schema create [flags]
```
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:-----|:--------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| `-n` | `--bucket` | ({{< req >}}) Bucket name (mutually exclusive with `--bucket-id`) | string | |
| `-i` | `--bucket-id` | ({{< req >}}) Bucket ID (mutually exclusive with `--bucket`) | string | |
| | `--columns-file` | ({{< req >}}) Path to column definitions file. For more information, see [Create a columns file](/influxdb/cloud/reference/cli/influx/bucket-schema/create/#create-a-columns-file). | string | |
| | `--columns-format` | Columns file format (`csv`, `ndjson`, `json`, default: `auto`). For more information, see [Create a schema with columns format](#create-a-schema-with-columns-format) | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-x` | `--extended-output` | Print column information for each measurement schema (default: false) | | |
| `-h` | `--help` | Help for the `create` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | ({{< req >}}) Measurement name | string | |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples
{{< cli/influx-creds-note >}}
- [Create a schema using the influx CLI](#create-a-schema-using-the-influx-cli)
- [Create a schema and print column information](#create-a-schema-and-print-column-information)
- [Create a schema with columns format](#create-a-schema-with-columns-format)
## Create a schema using the influx CLI
```sh
influx bucket-schema create \
--bucket example-bucket \
--name temperature \
--columns-file columns.csv
```
## Create a schema and print column information
```sh
influx bucket-schema create \
--bucket example-bucket \
--name cpu \
--columns-file columns.csv \
--extended-output
```
## Create a schema with columns format
By default, InfluxDB attempts to detect the **columns file** format.
If your file's extension doesn't match the format, set the format with the [`columns-format` flag](/influxdb/cloud/reference/cli/influx/bucket-schema/create).
```sh
influx bucket-schema create \
--bucket example-bucket \
--name cpu \
--columns-file columns.json \
--columns-format ndjson
```
```sh
influx bucket-schema create \
--bucket example-bucket \
--name cpu \
--columns-file columns.txt \
--columns-format csv
```

View File

@ -10,50 +10,4 @@ related:
- /influxdb/cloud/organizations/buckets/bucket-schema - /influxdb/cloud/organizations/buckets/bucket-schema
--- ---
The `influx bucket-schema list` command lists the schemas of an {{< duplicate-oss >}}
InfluxDB bucket that has the [`explicit` schema-type](/influxdb/cloud/reference/cli/influx/bucket/create/#create-a-bucket-with-an-explicit-schema).
## Usage
```sh
influx bucket-schema list [flags]
```
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:-----|:--------------------|:----------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| `-n` | `--bucket` | Bucket name (mutually exclusive with `--bucket-id`) | string | |
| `-i` | `--bucket-id` | Bucket ID (mutually exclusive with `--bucket`) | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-x` | `--extended-output` | Print column information for each measurement schema (default: false) | | |
| `-h` | `--help` | Help for the `create` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | Measurement name | string | |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples
{{< cli/influx-creds-note >}}
## List all schemas of a bucket and print column information
```sh
influx bucket-schema list \
--bucket example-bucket
--extended-output
```
## Print column details for a single measurement
```sh
influx bucket-schema list \
--bucket example-bucket \
--name cpu \
--extended-output
```

View File

@ -10,87 +10,4 @@ related:
- /influxdb/cloud/organizations/buckets/bucket-schema - /influxdb/cloud/organizations/buckets/bucket-schema
--- ---
The `influx bucket-schema update` command updates the schema of an InfluxDB bucket that has the [`explicit` schema-type](/influxdb/cloud/reference/cli/influx/bucket/create/#create-a-bucket-with-an-explicit-schema). {{< duplicate-oss >}}
`bucket-schema update` requires a bucket with at least one defined schema.
## Usage
```sh
influx bucket-schema update [flags]
```
##### Supported operations
- Adding new columns to a schema
##### Unsupported operations
- Modify existing columns in a schema
- Delete columns from a schema
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:-----|:--------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| `-n` | `--bucket` | ({{< req >}}) Bucket name (mutually exclusive with `--bucket-id`) | string | |
| `-i` | `--bucket-id` | ({{< req >}}) Bucket ID (mutually exclusive with `--bucket`) | string | |
| | `--columns-file` | ({{< req >}}) Path to column definitions file. For more information, see [Create a columns file](/influxdb/cloud/reference/cli/influx/bucket-schema/create/#create-a-columns-file). | string | |
| | `--columns-format` | Columns file format (`csv`, `ndjson`, `json`, default: `auto`). For more information, see [Update a schema with columns format](#update-a-schema-with-columns-format) | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-x` | `--extended-output` | Print column information for each measurement schema (default: false) | | |
| `-h` | `--help` | Help for the `create` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | ({{< req >}}) Measurement name | string | |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples
{{< cli/influx-creds-note >}}
- [Update a schema using the influx CLI](#update-a-schema-using-the-influx-cli)
- [Update a schema and print column information](#update-a-schema-and-print-column-information)
- [Update a schema with columns format](#update-a-schema-specifying-the-columns-format)
## Update a schema using the influx CLI
```sh
influx bucket-schema update \
--bucket example-bucket \
--name temperature \
--columns-file columns.csv
```
## Update a schema and print column information
```sh
influx bucket-schema update \
--bucket example-bucket \
--name cpu \
--columns-file columns.csv \
-extended-output
```
## Update a schema with columns format
By default, InfluxDB attempts to detect the **columns file** format.
If your file's extension doesn't match the format, set the format with the `columns-format` flag.
```sh
influx bucket-schema update \
--bucket example-bucket \
--name cpu \
--columns-file columns.json \
--columns-format ndjson
```
```sh
influx bucket-schema update \
--bucket example-bucket \
--name cpu \
--columns-file columns.txt \
--columns-format csv
```

View File

@ -12,6 +12,7 @@ cascade:
- /influxdb/cloud/organizations/buckets/ - /influxdb/cloud/organizations/buckets/
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
metadata: [influx CLI 2.0.0+]
--- ---
{{< duplicate-oss >}} {{< duplicate-oss >}}

View File

@ -12,6 +12,7 @@ related:
- /influxdb/cloud/organizations/buckets/create-buckets/ - /influxdb/cloud/organizations/buckets/create-buckets/
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
updated_in: CLI v2.1.0
--- ---
{{< duplicate-oss >}} {{< duplicate-oss >}}

View File

@ -6,6 +6,7 @@ menu:
name: influx bucket list name: influx bucket list
parent: influx bucket parent: influx bucket
weight: 201 weight: 201
updated_in: CLI v2.2.0
--- ---
{{< duplicate-oss >}} {{< duplicate-oss >}}

View File

@ -12,6 +12,7 @@ influxdb/cloud/tags: [cli, tools]
related: related:
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
metadata: [influx CLI 2.0.0+]
--- ---
{{< duplicate-oss >}} {{< duplicate-oss >}}

View File

@ -11,6 +11,7 @@ cascade:
related: related:
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
metadata: [influx CLI 2.0.0+]
--- ---
{{< duplicate-oss >}} {{< duplicate-oss >}}

View File

@ -11,6 +11,7 @@ influxdb/cloud/tags: [telegraf]
related: related:
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
metadata: [influx CLI 2.0.0+]
--- ---
{{< duplicate-oss >}} {{< duplicate-oss >}}

View File

@ -12,6 +12,8 @@ related:
- /influxdb/cloud/reference/syntax/delete-predicate - /influxdb/cloud/reference/syntax/delete-predicate
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
metadata: [influx CLI 2.0.3+]
updated_in: CLI v2.2.0
--- ---
{{< duplicate-oss >}} {{< duplicate-oss >}}

View File

@ -10,6 +10,7 @@ cascade:
- /influxdb/cloud/influxdb-templates/create/ - /influxdb/cloud/influxdb-templates/create/
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
metadata: [influx CLI 2.0.0+]
--- ---
{{< duplicate-oss >}} {{< duplicate-oss >}}

View File

@ -8,6 +8,8 @@ menu:
weight: 201 weight: 201
related: related:
- /influxdb/cloud/influxdb-templates/create/ - /influxdb/cloud/influxdb-templates/create/
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
--- ---
{{< duplicate-oss >}} {{< duplicate-oss >}}

View File

@ -9,6 +9,7 @@ weight: 101
related: related:
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
metadata: [influx CLI 2.0.0+]
--- ---
{{< duplicate-oss >}} {{< duplicate-oss >}}

View File

@ -11,6 +11,7 @@ cascade:
related: related:
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
metadata: [influx CLI 2.0.0+]
--- ---
{{< duplicate-oss >}} {{< duplicate-oss >}}

View File

@ -6,6 +6,15 @@ menu:
name: influx org create name: influx org create
parent: influx org parent: influx org
weight: 201 weight: 201
metadata: [influx CLI 2.0.0+, InfluxDB OSS only]
--- ---
{{% note %}}
#### Works with InfluxDB OSS 2.x
The `influx org create` command works with **InfluxDB OSS 2.x**, but does not work with **InfluxDB Cloud**.
New organizations are created for each new InfluxDB account.
For information about creating an InfluxDB Cloud account, see
[sign up for InfluxDB Cloud](/influxdb/cloud/sign-up/).
{{% /note %}}
{{< duplicate-oss >}} {{< duplicate-oss >}}

View File

@ -6,6 +6,15 @@ menu:
name: influx org delete name: influx org delete
parent: influx org parent: influx org
weight: 201 weight: 201
metadata: [influx CLI 2.0.0+, InfluxDB OSS only]
--- ---
{{% note %}}
#### Works with InfluxDB OSS 2.x
The `influx org delete` command works with **InfluxDB OSS 2.x**, but does not work with **InfluxDB Cloud**.
An organizations is associated with your InfluxDB account.
For information about removing your InfluxDB Cloud account and its organization,
see [Cancel your InfluxDB Cloud subscription](/influxdb/cloud/account-management/offboarding/).
{{% /note %}}
{{< duplicate-oss >}} {{< duplicate-oss >}}

View File

@ -6,10 +6,11 @@ menu:
name: influx org members name: influx org members
parent: influx org parent: influx org
weight: 201 weight: 201
metadata: [influx CLI 2.0.0+, InfluxDB OSS only]
--- ---
{{% note %}} {{% note %}}
#### Available with InfluxDB OSS 2.x only #### Works with InfluxDB OSS 2.x
The `influx org members` command works with **InfluxDB OSS 2.x**, but does not work with **InfluxDB Cloud**. The `influx org members` command works with **InfluxDB OSS 2.x**, but does not work with **InfluxDB Cloud**.
For information about managing users in your InfluxDB Cloud organization, see For information about managing users in your InfluxDB Cloud organization, see
[Manage multiple users](/influxdb/cloud/account-management/multi-user/). [Manage multiple users](/influxdb/cloud/account-management/multi-user/).

View File

@ -12,10 +12,11 @@ influxdb/cloud/tags: [ping, health]
related: related:
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
metadata: [influx CLI 2.0.0+, InfluxDB OSS only]
--- ---
{{% note %}} {{% note %}}
#### Available with InfluxDB OSS 2.x only #### Works with InfluxDB OSS 2.x
The `influx ping` command works with **InfluxDB OSS 2.x**, but does not work with **InfluxDB Cloud**. The `influx ping` command works with **InfluxDB OSS 2.x**, but does not work with **InfluxDB Cloud**.
{{% /note %}} {{% /note %}}

View File

@ -14,6 +14,8 @@ related:
- /influxdb/cloud/query-data/execute-queries/influx-query/ - /influxdb/cloud/query-data/execute-queries/influx-query/
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
metadata: [influx CLI 2.0.0+]
updated_in: CLI v2.0.5
--- ---
{{< duplicate-oss >}} {{< duplicate-oss >}}

View File

@ -9,77 +9,16 @@ weight: 101
related: related:
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
metadata: [influx CLI 2.0.0+]
updated_in: CLI v2.0.7
--- ---
{{% note %}} {{% note %}}
#### Available with InfluxDB OSS 2.x only #### Works with InfluxDB OSS 2.x
The `influx restore` command works with **InfluxDB OSS 2.x**, but does not work with **InfluxDB Cloud**. The `influx restore` command works with **InfluxDB OSS 2.x**, but does not work with **InfluxDB Cloud**.
For information about restoring data in InfluxDB Cloud, see For information about restoring data in InfluxDB Cloud, see
[InfluxDB Cloud durabilty](/influxdb/cloud/reference/internals/durability/) and [InfluxDB Cloud durability](/influxdb/cloud/reference/internals/durability/) and
[contact InfluxData Support](mailto:support@influxdata.com). [contact InfluxData Support](mailto:support@influxdata.com).
{{% /note %}} {{% /note %}}
The `influx restore` command restores backup data and metadata from an InfluxDB OSS backup directory. {{< duplicate-oss >}}
### The restore process
When restoring data from a backup file set, InfluxDB temporarily moves existing
data and metadata while `restore` runs.
After `restore` completes, the temporary data is deleted.
If the restore process fails, InfluxDB preserves the data in the temporary location.
_For information about recovering from a failed restore process, see
[Restore data](/influxdb/v2.0/backup-restore/restore/#recover-from-a-failed-restore)._
## Usage
```
influx restore [flags]
```
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:-----|:------------------|:----------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| `-b` | `--bucket` | Name of the bucket to restore (mutually exclusive with `--bucket-id`) | string | |
| | `--bucket-id` | ID of the bucket to restore (mutually exclusive with `--bucket`) | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| | `--full` | Fully restore and replace all data on server | | |
| `-h` | `--help` | Help for the `restore` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--new-bucket` | Name of the bucket to restore to | string | |
| | `--new-org` | Name of the organization to restore to | string | |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples
{{< cli/influx-creds-note >}}
- [Restore and replace all data](#restore-and-replace-all-data)
- [Restore backup data to an existing bucket](#restore-backup-data-to-an-existing-bucket)
- [Create a bucket and restore data to it](#create-a-bucket-and-restore-data-to-it)
##### Restore and replace all data
```sh
influx restore --full /path/to/backup/dir/
```
##### Restore backup data to an existing bucket
```sh
influx restore \
--bucket example-bucket \
/path/to/backup/dir/
```
##### Create a bucket and restore data to it
```sh
influx restore \
--new-bucket new-example-bucket \
/path/to/backup/dir/
```

View File

@ -6,12 +6,13 @@ menu:
name: influx secret name: influx secret
parent: influx parent: influx
weight: 101 weight: 101
influxdb/cloud/tags: [secrets]
cascade: cascade:
related: influxdb/cloud/tags: [secrets]
- /influxdb/cloud/security/secrets/ related:
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - /influxdb/cloud/security/secrets/
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
metadata: [influx CLI 2.0.0+]
--- ---
{{< duplicate-oss >}} {{< duplicate-oss >}}

View File

@ -6,7 +6,6 @@ menu:
name: influx secret delete name: influx secret delete
parent: influx secret parent: influx secret
weight: 101 weight: 101
influxdb/cloud/tags: [secrets]
--- ---
{{< duplicate-oss >}} {{< duplicate-oss >}}

View File

@ -6,7 +6,6 @@ menu:
name: influx secret list name: influx secret list
parent: influx secret parent: influx secret
weight: 101 weight: 101
influxdb/cloud/tags: [secrets]
--- ---
{{< duplicate-oss >}} {{< duplicate-oss >}}

View File

@ -6,7 +6,6 @@ menu:
name: influx secret update name: influx secret update
parent: influx secret parent: influx secret
weight: 101 weight: 101
influxdb/cloud/tags: [secrets]
--- ---
{{< duplicate-oss >}} {{< duplicate-oss >}}

View File

@ -12,11 +12,13 @@ influxdb/cloud/tags: [get-started]
related: related:
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
metadata: [influx CLI 2.0.0+, InfluxDB OSS only]
updated_in: CLI v2.0.3
canonical: /{{< latest "influxdb" "v2" >}}/reference/cli/influx/setup/ canonical: /{{< latest "influxdb" "v2" >}}/reference/cli/influx/setup/
--- ---
{{% note %}} {{% note %}}
#### Available with InfluxDB OSS 2.x only #### Works with InfluxDB OSS 2.x
The `influx setup` command initiates the setup process for **InfluxDB OSS 2.x** instances. The `influx setup` command initiates the setup process for **InfluxDB OSS 2.x** instances.
The command does not work with **InfluxDB Cloud**. The command does not work with **InfluxDB Cloud**.
{{% /note %}} {{% /note %}}

View File

@ -14,6 +14,7 @@ cascade:
- /influxdb/cloud/influxdb-templates/stacks/ - /influxdb/cloud/influxdb-templates/stacks/
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
metadata: [influx CLI 2.0.1+]
--- ---
{{< duplicate-oss >}} {{< duplicate-oss >}}

View File

@ -7,6 +7,7 @@ menu:
parent: influx stacks parent: influx stacks
weight: 201 weight: 201
influxdb/cloud/tags: [templates] influxdb/cloud/tags: [templates]
updated_in: CLI v2.0.4
--- ---
{{< duplicate-oss >}} {{< duplicate-oss >}}

View File

@ -12,6 +12,7 @@ cascade:
- /influxdb/cloud/process-data/ - /influxdb/cloud/process-data/
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
metadata: [influx CLI 2.0.0+]
--- ---
{{< duplicate-oss >}} {{< duplicate-oss >}}

View File

@ -6,6 +6,7 @@ menu:
name: influx task retry-failed name: influx task retry-failed
parent: influx task parent: influx task
weight: 201 weight: 201
metadata: [influx CLI 2.0.5+]
--- ---
{{< duplicate-oss >}} {{< duplicate-oss >}}

View File

@ -14,6 +14,7 @@ cascade:
- /influxdb/cloud/telegraf-configs/ - /influxdb/cloud/telegraf-configs/
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
metadata: [influx CLI 2.0.0+]
--- ---
{{< duplicate-oss >}} {{< duplicate-oss >}}

View File

@ -12,6 +12,7 @@ cascade:
- /influxdb/cloud/influxdb-templates/ - /influxdb/cloud/influxdb-templates/
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
metadata: [influx CLI 2.0.1+]
--- ---
{{< duplicate-oss >}} {{< duplicate-oss >}}

View File

@ -5,6 +5,18 @@ description: >
related: related:
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
metadata: [influx CLI 2.0.0 2.0.5]
prepend:
block: warn
content: |
### Removed in influx CLI v2.0.5
The `influx transpile` command was removed in **v2.0.5** of the `influx` CLI.
[Use InfluxQL to query InfluxDB](/influxdb/cloud/query-data/influxql/).
For information about manually converting InfluxQL queries to Flux, see:
- [Get started with Flux](/flux/v0.x/get-started/)
- [Query data with Flux](/influxdb/cloud/query-data/flux/)
- [Migrate continuous queries to Flux tasks](/influxdb/cloud/upgrade/v1-to-cloud/migrate-cqs/)
--- ---
{{< duplicate-oss >}} {{< duplicate-oss >}}

View File

@ -11,11 +11,12 @@ cascade:
related: related:
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
metadata: [influx CLI 2.0.0+, InfluxDB OSS only]
canonical: /{{< latest "influxdb" "v2" >}}/reference/cli/influx/user/ canonical: /{{< latest "influxdb" "v2" >}}/reference/cli/influx/user/
--- ---
{{% note %}} {{% note %}}
#### Available with InfluxDB OSS 2.x only #### Works with InfluxDB OSS 2.x
The `influx user` command and its subcommands manage **InfluxDB OSS 2.x** users, The `influx user` command and its subcommands manage **InfluxDB OSS 2.x** users,
but do not manage users in **InfluxDB Cloud**. but do not manage users in **InfluxDB Cloud**.
Use the InfluxDB Cloud user interface to manage account information. Use the InfluxDB Cloud user interface to manage account information.

View File

@ -10,7 +10,7 @@ canonical: /{{< latest "influxdb" "v2" >}}/reference/cli/influx/user/create/
--- ---
{{% note %}} {{% note %}}
#### Available with InfluxDB OSS 2.x only #### Works with InfluxDB OSS 2.x
The `influx user create` command creates users in **InfluxDB OSS 2.x**, The `influx user create` command creates users in **InfluxDB OSS 2.x**,
but does not create users in **InfluxDB Cloud**. but does not create users in **InfluxDB Cloud**.
For information about inviting users into your InfluxDB Cloud organization, see For information about inviting users into your InfluxDB Cloud organization, see

View File

@ -9,12 +9,12 @@ weight: 201
canonical: /{{< latest "influxdb" "v2" >}}/reference/cli/influx/user/delete/ canonical: /{{< latest "influxdb" "v2" >}}/reference/cli/influx/user/delete/
--- ---
{{% cloud %}} {{% note %}}
#### Available with InfluxDB OSS 2.x only #### Works with InfluxDB OSS 2.x
The `influx user delete` command deletes users from **InfluxDB OSS 2.x**, The `influx user delete` command deletes users from **InfluxDB OSS 2.x**,
but does not delete users from **InfluxDB Cloud**. but does not delete users from **InfluxDB Cloud**.
For information about removing a user from your InfluxDB Cloud organization, see For information about removing a user from your InfluxDB Cloud organization, see
[Remove a user](/influxdb/cloud/account-management/multi-user/remove-user/). [Remove a user](/influxdb/cloud/account-management/multi-user/remove-user/).
{{% /cloud %}} {{% /note %}}
{{< duplicate-oss >}} {{< duplicate-oss >}}

View File

@ -12,11 +12,11 @@ canonical: /{{< latest "influxdb" "v2" >}}/reference/cli/influx/user/list/
--- ---
{{% note %}} {{% note %}}
#### Available with InfluxDB OSS 2.x only #### Works with InfluxDB OSS 2.x
The `influx user list` command lists users in **InfluxDB OSS 2.x**, The `influx user list` command lists users in **InfluxDB OSS 2.x**,
but does not list users in **InfluxDB Cloud**. but does not list users in **InfluxDB Cloud**.
For information about managing InfluxDB Cloud users, see For information about managing InfluxDB Cloud users, see
[Manage multiple users](/influxdb/cloud/account-management/multi-user/.) [Manage multiple users](/influxdb/cloud/account-management/multi-user/).
{{% /note %}} {{% /note %}}
{{< duplicate-oss >}} {{< duplicate-oss >}}

Some files were not shown because too many files have changed in this diff Show More