address more PR feedback
Scott Anderson
parent
5e80bb82fa
commit
bad6817bf4
163
CONTRIBUTING.md
163
CONTRIBUTING.md
|
|
@ -51,7 +51,17 @@ You need a database that specializes in time series.
|
|||
+You need InfluxDB.
|
||||
```
|
||||
|
||||
### Page frontmatter
|
||||
### Article headings
|
||||
Use only h2-h6 headings in markdown content.
|
||||
h1 headings act as the page title and are populated automatically from the `title` frontmatter.
|
||||
h2-h6 headings act as section headings.
|
||||
|
||||
### Image naming conventions
|
||||
Save images using the following naming format: `project/version-context-description.png`.
|
||||
For example, `influxdb/2-0-visualizations-line-graph.png` or `influxdb/2-0-tasks-add-new.png`.
|
||||
Specify a version other than 2.0 only if the image is specific to that version.
|
||||
|
||||
## Page frontmatter
|
||||
Every documentation page includes frontmatter which specifies information about the page.
|
||||
Frontmatter populates variables in page templates and the site's navigation menu.
|
||||
|
||||
|
|
@ -66,7 +76,7 @@ menu:
|
|||
parent: # Specifies a parent group and nests navigation items
|
||||
weight: # Determines sort order in both the nav tree and in article lists
|
||||
draft: # If true, will not render page on build
|
||||
v2.x/tags: # Tags specific to each version (replace .x" with the appropriate minor version )
|
||||
product/v2.x/tags: # Tags specific to each version (replace product and .x" with the appropriate product and minor version )
|
||||
related: # Creates links to specific internal and external content at the bottom of the page
|
||||
- /path/to/related/article
|
||||
- https://external-link.com, This is an external link
|
||||
|
|
@ -81,7 +91,7 @@ canonical: # Path to canonical page, overrides auto-gen'd canonical URL
|
|||
v2: # Path to v2 equivalent page
|
||||
```
|
||||
|
||||
#### Title usage
|
||||
### Title usage
|
||||
|
||||
##### `title`
|
||||
The `title` frontmatter populates each page's h1 header.
|
||||
|
|
@ -108,10 +118,68 @@ Then 201-299 and so on.
|
|||
|
||||
_**Note:** `_index.md` files should be weighted one level up from the other `.md` files in the same directory._
|
||||
|
||||
### Article headings
|
||||
Use only h2-h6 headings in markdown content.
|
||||
h1 headings act as the page title and are populated automatically from the `title` frontmatter.
|
||||
h2-h6 headings act as section headings.
|
||||
### Related content
|
||||
Use the `related` frontmatter to include links to specific articles at the bottom of an article.
|
||||
|
||||
- If the page exists inside of this documentation, just include the path to the page.
|
||||
It will automatically detect the title of the page.
|
||||
- If the page exists inside of this documentation, but you want to customize the link text,
|
||||
include the path to the page followed by a comma, and then the custom link text.
|
||||
The path and custom text must be in that order and separated by a comma and a space.
|
||||
- If the page exists outside of this documentation, include the full URL and a title for the link.
|
||||
The link and title must be in that order and separated by a comma and a space.
|
||||
|
||||
```yaml
|
||||
related:
|
||||
- /v2.0/write-data/quick-start
|
||||
- /v2.0/write-data/quick-start, This is custom text for an internal link
|
||||
- https://influxdata.com, This is an external link
|
||||
```
|
||||
|
||||
### Canonical URLs
|
||||
Search engines use canonical URLs to accurately rank pages with similar or identical content.
|
||||
The `canonical` HTML meta tag identifies which page should be used as the source of truth.
|
||||
|
||||
By default, canonical URLs are automatically generated for each page in the InfluxData
|
||||
documentation using the latest version of the current product and the current path.
|
||||
|
||||
Use the `canonical` frontmatter to override the auto-generated canonical URL.
|
||||
|
||||
_**Note:** The `canonical` frontmatter supports the [`{{< latest >}}` shortcode](#latest-links)._
|
||||
|
||||
```yaml
|
||||
canonical: /path/to/canonical/doc/
|
||||
|
||||
# OR
|
||||
|
||||
canonical: /{{< latest "influxdb" "v2" >}}/path/to/canonical/doc/
|
||||
```
|
||||
|
||||
## v2 equivalent documentation
|
||||
To display a notice on a 1.x page that links to an equivalent 2.0 page,
|
||||
add the following frontmatter to the 1.x page:
|
||||
|
||||
```yaml
|
||||
v2: /influxdb/v2.0/get-started/
|
||||
```
|
||||
|
||||
### Cascade
|
||||
To automatically apply frontmatter to a page and all of its children, use the
|
||||
[`cascade` frontmatter](https://gohugo.io/content-management/front-matter/#front-matter-cascade)
|
||||
built in into Hugo.
|
||||
|
||||
```yaml
|
||||
title: Example page
|
||||
description: Example description
|
||||
cascade:
|
||||
layout: custom-layout
|
||||
```
|
||||
|
||||
`cascade` applies the frontmatter to all children unless the child already includes
|
||||
those frontmatter keys. Frontmaatter defined on the page overrides fronmattered
|
||||
"cascaded" from a parent.
|
||||
|
||||
## Shortcodes
|
||||
|
||||
### Notes and warnings
|
||||
Shortcodes are available for formatting notes and warnings in each article:
|
||||
|
|
@ -135,13 +203,6 @@ Insert enterprise-specific markdown content here.
|
|||
{{% /enterprise %}}
|
||||
```
|
||||
|
||||
#### All content is Enterprise-specific
|
||||
If all content in an article is Enterprise-specific, include `enterprise`in the `products` frontmatter.
|
||||
|
||||
```yaml
|
||||
products: [enterprise]
|
||||
```
|
||||
|
||||
#### Enterprise name
|
||||
The name used to refer to InfluxData's enterprise offering is subject to change.
|
||||
To facilitate easy updates in the future, use the `enterprise-name` shortcode
|
||||
|
|
@ -175,13 +236,6 @@ Insert cloud-specific markdown content here.
|
|||
{{% /cloud %}}
|
||||
```
|
||||
|
||||
#### All content is cloud-specific
|
||||
If all content in an article is cloud-specific, include `cloud` in the `products` frontmatter.
|
||||
|
||||
```yaml
|
||||
products: [cloud]
|
||||
```
|
||||
|
||||
#### InfluxDB Cloud name
|
||||
The name used to refer to InfluxData's cloud offering is subject to change.
|
||||
To facilitate easy updates in the future, use the `cloud-name` short-code when
|
||||
|
|
@ -206,13 +260,6 @@ InfluxDB Cloud.
|
|||
Find more info [here][{{< cloud-link >}}]
|
||||
```
|
||||
|
||||
### InfluxDB OSS Content
|
||||
If all content in an article is OSS-specific, include `oss` in the `products` frontmatter.
|
||||
|
||||
```yaml
|
||||
products: [oss]
|
||||
```
|
||||
|
||||
### Latest links
|
||||
Each of the InfluxData projects have different "latest" versions.
|
||||
Use the `{{< latest >}}` shortcode to populate link paths with the latest version
|
||||
|
|
@ -384,20 +431,6 @@ The following parameters are available:
|
|||
{{< keybind mac="⇧⌘P" linux="Ctrl+Shift+P" win="Ctrl+Shift+Alt+P" >}}
|
||||
```
|
||||
|
||||
### Related content
|
||||
Use the `related` frontmatter to include links to specific articles at the bottom of an article.
|
||||
|
||||
- If the page exists inside of this documentation, just include the path to the page.
|
||||
It will automatically detect the title of the page.
|
||||
- If the page exists outside of this documentation, include the full URL and a title for the link.
|
||||
The link and title must be in that order and must be separated by a comma and a space.
|
||||
|
||||
```yaml
|
||||
related:
|
||||
- /v2.0/write-data/quick-start
|
||||
- https://influxdata.com, This is an external link
|
||||
```
|
||||
|
||||
### High-resolution images
|
||||
In many cases, screenshots included in the docs are taken from high-resolution (retina) screens.
|
||||
Because of this, the actual pixel dimension is 2x larger than it needs to be and is rendered 2x bigger than it should be.
|
||||
|
|
@ -690,44 +723,6 @@ menu:
|
|||
influxdb_2_0_ref:
|
||||
# ...
|
||||
```
|
||||
### Image naming conventions
|
||||
Save images using the following naming format: `project/version-context-description.png`.
|
||||
For example, `influxdb/2-0-visualizations-line-graph.png` or `influxdb/2-0-tasks-add-new.png`.
|
||||
Specify a version other than 2.0 only if the image is specific to that version.
|
||||
|
||||
## InfluxDB API documentation
|
||||
InfluxData uses [Redoc](https://github.com/Redocly/redoc) to generate the full
|
||||
InfluxDB API documentation when documentation is deployed.
|
||||
Redoc generates HTML documentation using the InfluxDB `swagger.yml`.
|
||||
For more information about generating InfluxDB API documentation, see the
|
||||
[API Documentation README](https://github.com/influxdata/docs-v2/tree/master/api-docs#readme).
|
||||
|
||||
## Canonical URLs
|
||||
Search engines use canonical URLs to accurately rank pages with similar or identical content.
|
||||
The `canonical` HTML meta tag identifies which page should be used as the source of truth.
|
||||
|
||||
By default, canonical URLs are automatically generated for each page in the InfluxData
|
||||
documentation using the latest version of the current product and the current path.
|
||||
|
||||
Use the `canonical` frontmatter to override the auto-generated canonical URL.
|
||||
|
||||
_**Note:** The `canonical` frontmatter supports the [`{{< latest >}}` shortcode](#latest-links)._
|
||||
|
||||
```yaml
|
||||
canonical: /path/to/canonical/doc/
|
||||
|
||||
# OR
|
||||
|
||||
canonical: /{{< latest "influxdb" "v2" >}}/path/to/canonical/doc/
|
||||
```
|
||||
|
||||
## v2 equivalent documentation
|
||||
To display a notice on a 1.x page that links to an equivalent 2.0 page,
|
||||
add the following frontmatter to the 1.x page:
|
||||
|
||||
```yaml
|
||||
v2: /influxdb/v2.0/get-started/
|
||||
```
|
||||
|
||||
## InfluxDB URLs
|
||||
When a user selects an InfluxDB product and region, example URLs in code blocks
|
||||
|
|
@ -829,8 +824,14 @@ _This example assumes v2.0 is the most recent version and v2.1 is the new versio
|
|||
|
||||
8. Commit the changes and push the new branch to Github.
|
||||
|
||||
|
||||
These changes lay the foundation for the new version.
|
||||
All other changes specific to the new version should be merged into this branch.
|
||||
Once the necessary changes are in place and the new version is released,
|
||||
merge the new branch into `master`.
|
||||
|
||||
## InfluxDB API documentation
|
||||
InfluxData uses [Redoc](https://github.com/Redocly/redoc) to generate the full
|
||||
InfluxDB API documentation when documentation is deployed.
|
||||
Redoc generates HTML documentation using the InfluxDB `swagger.yml`.
|
||||
For more information about generating InfluxDB API documentation, see the
|
||||
[API Documentation README](https://github.com/influxdata/docs-v2/tree/master/api-docs#readme).
|
||||
|
|
|
|||
|
|
@ -10,7 +10,8 @@ aliases:
|
|||
- /influxdb/cloud/reference/cli/influx/pkg/
|
||||
influxdb/cloud/tags: [templates]
|
||||
related:
|
||||
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI 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
|
||||
---
|
||||
|
||||
{{< duplicate-oss >}}
|
||||
|
|
|
|||
|
|
@ -9,7 +9,8 @@ weight: 101
|
|||
influxdb/cloud/tags: [authentication]
|
||||
cascade:
|
||||
related:
|
||||
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI 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
|
||||
---
|
||||
|
||||
{{< duplicate-oss >}}
|
||||
|
|
|
|||
|
|
@ -8,7 +8,8 @@ menu:
|
|||
weight: 101
|
||||
influxdb/cloud/tags: [backup]
|
||||
related:
|
||||
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI 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
|
||||
---
|
||||
|
||||
{{% note %}}
|
||||
|
|
|
|||
|
|
@ -10,7 +10,8 @@ influxdb/cloud/tags: [buckets]
|
|||
cascade:
|
||||
related:
|
||||
- /influxdb/cloud/organizations/buckets/
|
||||
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI 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
|
||||
---
|
||||
|
||||
{{< duplicate-oss >}}
|
||||
|
|
|
|||
|
|
@ -10,7 +10,8 @@ aliases:
|
|||
- /influxdb/cloud/reference/cli/influx/bucket/create/
|
||||
related:
|
||||
- /influxdb/cloud/organizations/buckets/create-buckets/
|
||||
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI 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
|
||||
---
|
||||
|
||||
{{< duplicate-oss >}}
|
||||
|
|
|
|||
|
|
@ -8,7 +8,8 @@ menu:
|
|||
weight: 201
|
||||
related:
|
||||
- /influxdb/cloud/organizations/buckets/delete-bucket/
|
||||
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI 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
|
||||
---
|
||||
|
||||
{{< duplicate-oss >}}
|
||||
|
|
|
|||
|
|
@ -10,7 +10,8 @@ menu:
|
|||
weight: 101
|
||||
influxdb/cloud/tags: [cli, tools]
|
||||
related:
|
||||
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI 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
|
||||
---
|
||||
|
||||
{{< duplicate-oss >}}
|
||||
|
|
|
|||
|
|
@ -9,7 +9,8 @@ weight: 101
|
|||
influxdb/cloud/tags: [config]
|
||||
cascade:
|
||||
related:
|
||||
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI 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
|
||||
---
|
||||
|
||||
{{< duplicate-oss >}}
|
||||
|
|
|
|||
|
|
@ -9,7 +9,8 @@ menu:
|
|||
weight: 101
|
||||
influxdb/cloud/tags: [telegraf]
|
||||
related:
|
||||
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI 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
|
||||
---
|
||||
|
||||
{{< duplicate-oss >}}
|
||||
|
|
|
|||
|
|
@ -10,7 +10,8 @@ influxdb/cloud/tags: [delete]
|
|||
related:
|
||||
- /influxdb/cloud/write-data/delete-data
|
||||
- /influxdb/cloud/reference/syntax/delete-predicate
|
||||
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI 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
|
||||
---
|
||||
|
||||
{{< duplicate-oss >}}
|
||||
|
|
|
|||
|
|
@ -8,7 +8,8 @@ weight: 101
|
|||
cascade:
|
||||
related:
|
||||
- /influxdb/cloud/influxdb-templates/create/
|
||||
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI 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
|
||||
---
|
||||
|
||||
{{< duplicate-oss >}}
|
||||
|
|
|
|||
|
|
@ -7,7 +7,8 @@ menu:
|
|||
parent: influx
|
||||
weight: 101
|
||||
related:
|
||||
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI 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
|
||||
---
|
||||
|
||||
{{< duplicate-oss >}}
|
||||
|
|
|
|||
|
|
@ -9,7 +9,8 @@ weight: 101
|
|||
influxdb/cloud/tags: [organizations]
|
||||
cascade:
|
||||
related:
|
||||
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI 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
|
||||
---
|
||||
|
||||
{{< duplicate-oss >}}
|
||||
|
|
|
|||
|
|
@ -10,7 +10,8 @@ menu:
|
|||
weight: 101
|
||||
influxdb/cloud/tags: [ping, health]
|
||||
related:
|
||||
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI 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
|
||||
---
|
||||
|
||||
{{< duplicate-oss >}}
|
||||
|
|
|
|||
|
|
@ -11,7 +11,8 @@ weight: 101
|
|||
influxdb/cloud/tags: [query]
|
||||
related:
|
||||
- /influxdb/cloud/query-data/
|
||||
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI 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
|
||||
---
|
||||
|
||||
{{< duplicate-oss >}}
|
||||
|
|
|
|||
|
|
@ -7,7 +7,8 @@ menu:
|
|||
parent: influx
|
||||
weight: 101
|
||||
related:
|
||||
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI 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
|
||||
---
|
||||
|
||||
{{% note %}}
|
||||
|
|
|
|||
|
|
@ -10,7 +10,8 @@ influxdb/cloud/tags: [secrets]
|
|||
cascade:
|
||||
related:
|
||||
- /influxdb/cloud/security/secrets/
|
||||
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI 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
|
||||
---
|
||||
|
||||
{{< duplicate-oss >}}
|
||||
|
|
|
|||
|
|
@ -10,7 +10,8 @@ menu:
|
|||
weight: 101
|
||||
influxdb/cloud/tags: [get-started]
|
||||
related:
|
||||
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI 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
|
||||
canonical: /{{< latest "influxdb" "v2" >}}/reference/cli/influx/setup/
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -9,9 +9,11 @@ menu:
|
|||
parent: influx
|
||||
weight: 101
|
||||
influxdb/cloud/tags: [templates]
|
||||
related:
|
||||
- /influxdb/cloud/influxdb-templates/stacks/
|
||||
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
|
||||
cascade:
|
||||
related:
|
||||
- /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/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
|
||||
---
|
||||
|
||||
{{< duplicate-oss >}}
|
||||
|
|
|
|||
|
|
@ -10,7 +10,8 @@ influxdb/cloud/tags: [tasks]
|
|||
cascade:
|
||||
related:
|
||||
- /influxdb/cloud/process-data/
|
||||
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI 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
|
||||
---
|
||||
|
||||
{{< duplicate-oss >}}
|
||||
|
|
|
|||
|
|
@ -12,7 +12,8 @@ influxdb/cloud/tags: [telegraf]
|
|||
cascade:
|
||||
related:
|
||||
- /influxdb/cloud/telegraf-configs/
|
||||
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI 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
|
||||
---
|
||||
|
||||
{{< duplicate-oss >}}
|
||||
|
|
|
|||
|
|
@ -10,7 +10,8 @@ influxdb/cloud/tags: [templates]
|
|||
cascade:
|
||||
related:
|
||||
- /influxdb/cloud/influxdb-templates/
|
||||
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI 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
|
||||
---
|
||||
|
||||
{{< duplicate-oss >}}
|
||||
|
|
|
|||
|
|
@ -9,7 +9,8 @@ menu:
|
|||
weight: 101
|
||||
influxdb/cloud/tags: [influxql, flux]
|
||||
related:
|
||||
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI 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
|
||||
---
|
||||
|
||||
{{< duplicate-oss >}}
|
||||
|
|
|
|||
|
|
@ -9,7 +9,8 @@ weight: 101
|
|||
influxdb/cloud/tags: [users]
|
||||
cascade:
|
||||
related:
|
||||
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI 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
|
||||
canonical: /{{< latest "influxdb" "v2" >}}/reference/cli/influx/user/
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,8 @@ menu:
|
|||
weight: 201
|
||||
related:
|
||||
- /influxdb/cloud/account-management/change-password/
|
||||
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI 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
|
||||
canonical: /{{< latest "influxdb" "v2" >}}/reference/cli/influx/user/password/
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,8 @@ menu:
|
|||
weight: 101
|
||||
cascade:
|
||||
related:
|
||||
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI 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
|
||||
---
|
||||
|
||||
{{< duplicate-oss >}}
|
||||
|
|
|
|||
|
|
@ -16,7 +16,8 @@ cascade:
|
|||
- /influxdb/cloud/reference/syntax/line-protocol/
|
||||
- /influxdb/cloud/reference/syntax/annotated-csv/
|
||||
- /influxdb/cloud/reference/syntax/annotated-csv/extended/
|
||||
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI 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
|
||||
---
|
||||
|
||||
{{< duplicate-oss >}}
|
||||
|
|
|
|||
|
|
@ -22,6 +22,26 @@ influx [flags]
|
|||
influx [command]
|
||||
```
|
||||
|
||||
### Provide required authentication credentials
|
||||
To avoid having to pass your InfluxDB **host**, **authentication 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/v2.0/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-auth-token \
|
||||
--active
|
||||
```
|
||||
|
||||
For more information about managing CLI configurations, see the
|
||||
[`influx config` documentation](/influxdb/v2.0/reference/cli/influx/config/).
|
||||
|
||||
## Commands
|
||||
|
||||
| Command | Description |
|
||||
|
|
@ -57,40 +77,19 @@ influx [command]
|
|||
|:---- |:--- |:----------- |
|
||||
| `-h` | `--help` | Help for the `influx` command |
|
||||
|
||||
## Patterns and conventions
|
||||
### Flag patterns and conventions
|
||||
The `influx` CLI uses the following patterns and conventions:
|
||||
|
||||
- [Provide required authentication credentials](#provide-required-authentication-credentials)
|
||||
- [Mapped environment variables](#mapped-environment-variables)
|
||||
- [Shorthand and longhand flags](#shorthand-and-longhand-flags)
|
||||
- [Flag input types](#flag-input-types)
|
||||
|
||||
### Provide required authentication credentials
|
||||
To avoid having to pass your InfluxDB **host**, **authentication 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/v2.0/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-auth-token \
|
||||
--active
|
||||
```
|
||||
|
||||
For more information about managing CLI configurations, see the
|
||||
[`influx config` documentation](/influxdb/v2.0/reference/cli/influx/config/).
|
||||
|
||||
### Mapped environment variables
|
||||
#### 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
|
||||
#### 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`).
|
||||
|
|
@ -99,18 +98,19 @@ Many `influx` CLI flags support both shorthand and longhand forms.
|
|||
|
||||
Commands can use both shorthand and longhand flags in a single execution.
|
||||
|
||||
### Flag input types
|
||||
`influx` CLI flags support the following input types:
|
||||
#### 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
|
||||
##### string
|
||||
Text string, but the flag can be used **only once** per command execution.
|
||||
|
||||
#### stringArray
|
||||
##### stringArray
|
||||
Single text string, but the flag can be used **multiple times** per command execution.
|
||||
|
||||
#### integer
|
||||
##### integer
|
||||
Sequence of digits representing an integer value.
|
||||
|
||||
#### duration
|
||||
##### duration
|
||||
Length of time represented by an integer and a duration unit
|
||||
(`1ns`, `1us`, `1µs`, `1ms`, `1s`, `1m`, `1h`, `1d`, `1w`).
|
||||
|
|
|
|||
|
|
@ -10,7 +10,8 @@ aliases:
|
|||
- /influxdb/v2.0/reference/cli/influx/pkg/
|
||||
influxdb/v2.0/tags: [templates]
|
||||
related:
|
||||
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
|
||||
- /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
|
||||
- /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
|
||||
---
|
||||
|
||||
The `influx apply` command applies InfluxDB templates.
|
||||
|
|
|
|||
|
|
@ -9,7 +9,8 @@ weight: 101
|
|||
influxdb/v2.0/tags: [authentication]
|
||||
cascade:
|
||||
related:
|
||||
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
|
||||
- /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
|
||||
- /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
|
||||
---
|
||||
|
||||
The `influx auth` command and its subcommands manage authentication tokens in InfluxDB.
|
||||
|
|
|
|||
|
|
@ -11,6 +11,13 @@ weight: 201
|
|||
The `influx auth inactive` command inactivates an authentication token in InfluxDB.
|
||||
Inactive tokens **do not** authorize access to InfluxDB.
|
||||
|
||||
To temporarily disable client access to InfluxDB, inactivate the authentication
|
||||
token the client is using rather than delete the token.
|
||||
If you delete the token, you have to generate a new token and update the client
|
||||
with the new token.
|
||||
By setting a token to inactive, you can [activate the token](/influxdb/v2.0/reference/cli/influx/auth/active/)
|
||||
to grant the client access without having to modify the client.
|
||||
|
||||
## Usage
|
||||
```
|
||||
influx auth inactive [flags]
|
||||
|
|
|
|||
|
|
@ -9,7 +9,8 @@ weight: 101
|
|||
influxdb/v2.0/tags: [backup]
|
||||
related:
|
||||
- /influxdb/v2.0/backup-restore/backup/
|
||||
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
|
||||
- /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
|
||||
- /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
|
||||
---
|
||||
|
||||
The `influx backup` command backs up data stored in InfluxDB to a specified directory.
|
||||
|
|
|
|||
|
|
@ -9,7 +9,8 @@ weight: 101
|
|||
influxdb/v2.0/tags: [buckets]
|
||||
cascade:
|
||||
related:
|
||||
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
|
||||
- /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
|
||||
- /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
|
||||
---
|
||||
|
||||
The `influx bucket` command and its subcommands manage buckets in InfluxDB.
|
||||
|
|
|
|||
|
|
@ -10,7 +10,8 @@ aliases:
|
|||
- /influxdb/v2.0/reference/cli/influx/bucket/create/
|
||||
related:
|
||||
- /influxdb/v2.0/organizations/buckets/create-bucket/
|
||||
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
|
||||
- /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
|
||||
- /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
|
||||
---
|
||||
|
||||
The `influx bucket create` command creates a bucket in InfluxDB.
|
||||
|
|
|
|||
|
|
@ -10,7 +10,8 @@ aliases:
|
|||
- /influxdb/v2.0/reference/cli/influx/bucket/delete/
|
||||
related:
|
||||
- /influxdb/v2.0/organizations/buckets/delete-bucket/
|
||||
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
|
||||
- /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
|
||||
- /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
|
||||
---
|
||||
|
||||
The `influx bucket delete` command deletes a bucket from InfluxDB and all the data it contains.
|
||||
|
|
|
|||
|
|
@ -10,7 +10,8 @@ menu:
|
|||
weight: 101
|
||||
influxdb/v2.0/tags: [cli, tools]
|
||||
related:
|
||||
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
|
||||
- /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
|
||||
- /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
|
||||
---
|
||||
|
||||
The `influx completion` command outputs `influx` shell completion scripts for a
|
||||
|
|
|
|||
|
|
@ -9,7 +9,8 @@ weight: 101
|
|||
influxdb/v2.0/tags: [config]
|
||||
cascade:
|
||||
related:
|
||||
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
|
||||
- /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
|
||||
- /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
|
||||
---
|
||||
|
||||
The `influx config` command displays the active InfluxDB connection configuration
|
||||
|
|
|
|||
|
|
@ -9,7 +9,8 @@ menu:
|
|||
weight: 101
|
||||
influxdb/v2.0/tags: [telegraf]
|
||||
related:
|
||||
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
|
||||
- /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
|
||||
- /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
|
||||
---
|
||||
|
||||
The `influx dashboards` command lists existing InfluxDB dashboards.
|
||||
|
|
|
|||
|
|
@ -10,7 +10,8 @@ influxdb/v2.0/tags: [delete]
|
|||
related:
|
||||
- /influxdb/v2.0/write-data/delete-data
|
||||
- /influxdb/v2.0/reference/syntax/delete-predicate
|
||||
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
|
||||
- /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
|
||||
- /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
|
||||
---
|
||||
|
||||
The `influx delete` command deletes [points](/influxdb/v2.0/reference/glossary/#point)
|
||||
|
|
|
|||
|
|
@ -9,7 +9,8 @@ aliases:
|
|||
- /influxdb/v2.0/reference/cli/influx/pkg/export/
|
||||
related:
|
||||
- /influxdb/v2.0/influxdb-templates/create/
|
||||
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
|
||||
- /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
|
||||
- /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
|
||||
---
|
||||
|
||||
The `influx export` command exports existing resources as an InfluxDB template.
|
||||
|
|
|
|||
|
|
@ -10,7 +10,8 @@ aliases:
|
|||
- /influxdb/v2.0/reference/cli/influx/pkg/export/all/
|
||||
related:
|
||||
- /influxdb/v2.0/influxdb-templates/create/
|
||||
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
|
||||
- /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
|
||||
- /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
|
||||
---
|
||||
|
||||
The `influx export all` command exports all resources in an
|
||||
|
|
|
|||
|
|
@ -9,7 +9,8 @@ weight: 201
|
|||
aliases:
|
||||
- /influxdb/v2.0/reference/cli/influx/pkg/export/stack
|
||||
related:
|
||||
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
|
||||
- /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
|
||||
- /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
|
||||
---
|
||||
|
||||
The `influx export stack` command exports all resources associated with a stack as a template.
|
||||
|
|
|
|||
|
|
@ -7,7 +7,8 @@ menu:
|
|||
parent: influx
|
||||
weight: 101
|
||||
related:
|
||||
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
|
||||
- /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
|
||||
- /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
|
||||
---
|
||||
|
||||
The `influx help` command provides help for any command in the `influx` command line interface.
|
||||
|
|
|
|||
|
|
@ -9,7 +9,8 @@ weight: 101
|
|||
influxdb/v2.0/tags: [organizations]
|
||||
cascade:
|
||||
related:
|
||||
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
|
||||
- /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
|
||||
- /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
|
||||
---
|
||||
|
||||
The `influx org` command and its subcommands manage organization information in InfluxDB.
|
||||
|
|
|
|||
|
|
@ -10,7 +10,8 @@ menu:
|
|||
weight: 101
|
||||
influxdb/v2.0/tags: [ping, health]
|
||||
related:
|
||||
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
|
||||
- /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
|
||||
- /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
|
||||
---
|
||||
|
||||
The `influx ping` command checks the health of a running InfluxDB instance by
|
||||
|
|
|
|||
|
|
@ -11,7 +11,8 @@ weight: 101
|
|||
influxdb/v2.0/tags: [query]
|
||||
related:
|
||||
- /influxdb/v2.0/query-data/
|
||||
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
|
||||
- /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
|
||||
- /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
|
||||
---
|
||||
|
||||
The `influx query` command executes a literal Flux query provided as a string
|
||||
|
|
|
|||
|
|
@ -5,7 +5,8 @@ description: >
|
|||
from which you can run Flux commands.
|
||||
influxdb/v2.0/tags: [query]
|
||||
related:
|
||||
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
|
||||
- /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
|
||||
- /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
|
||||
---
|
||||
|
||||
{{% warn %}}
|
||||
|
|
|
|||
|
|
@ -10,7 +10,8 @@ alias:
|
|||
- /influxdb/v2.0/reference/cli/influxd/restore/
|
||||
related:
|
||||
- /influxdb/v2.0/backup-restore/restore/
|
||||
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
|
||||
- /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
|
||||
- /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
|
||||
---
|
||||
|
||||
The `influx restore` command restores backup data and metadata from an InfluxDB backup directory.
|
||||
|
|
|
|||
|
|
@ -10,7 +10,8 @@ influxdb/v2.0/tags: [secrets]
|
|||
cascade:
|
||||
related:
|
||||
- /influxdb/v2.0/security/secrets/
|
||||
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
|
||||
- /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
|
||||
- /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
|
||||
---
|
||||
|
||||
The `influx secret` command manages [secrets](/influxdb/v2.0/reference/glossary/#secret).
|
||||
|
|
|
|||
|
|
@ -10,7 +10,8 @@ menu:
|
|||
weight: 101
|
||||
influxdb/v2.0/tags: [get-started]
|
||||
related:
|
||||
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
|
||||
- /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
|
||||
- /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
|
||||
canonical: /{{< latest "influxdb" "v2" >}}/reference/cli/influx/setup/
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -14,7 +14,8 @@ influxdb/v2.0/tags: [templates]
|
|||
cascade:
|
||||
related:
|
||||
- /influxdb/v2.0/influxdb-templates/stacks/
|
||||
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
|
||||
- /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
|
||||
- /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
|
||||
---
|
||||
|
||||
The `influx stacks` command and its subcommands list and manage InfluxDB stacks
|
||||
|
|
|
|||
|
|
@ -10,7 +10,8 @@ influxdb/v2.0/tags: [tasks]
|
|||
cascade:
|
||||
related:
|
||||
- /influxdb/v2.0/process-data/
|
||||
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
|
||||
- /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
|
||||
- /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
|
||||
---
|
||||
|
||||
The `influx task` command and its subcommands manage tasks in InfluxDB.
|
||||
|
|
|
|||
|
|
@ -12,7 +12,8 @@ influxdb/v2.0/tags: [telegraf]
|
|||
cascade:
|
||||
related:
|
||||
- /influxdb/v2.0/telegraf-configs/
|
||||
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
|
||||
- /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
|
||||
- /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
|
||||
---
|
||||
|
||||
The `influx telegrafs` command lists Telegraf configurations.
|
||||
|
|
|
|||
|
|
@ -12,7 +12,8 @@ aliases:
|
|||
cascade:
|
||||
related:
|
||||
- /influxdb/v2.0/influxdb-templates/
|
||||
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
|
||||
- /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
|
||||
- /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
|
||||
---
|
||||
|
||||
The `influx template` command summarizes the specified InfluxDB template.
|
||||
|
|
|
|||
|
|
@ -9,7 +9,8 @@ menu:
|
|||
weight: 101
|
||||
influxdb/v2.0/tags: [influxql, flux]
|
||||
related:
|
||||
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
|
||||
- /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
|
||||
- /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
|
||||
---
|
||||
|
||||
The `influx transpile` command transpiles an InfluxQL query to Flux source code.
|
||||
|
|
|
|||
|
|
@ -10,7 +10,8 @@ influxdb/v2.0/tags: [users]
|
|||
cascade:
|
||||
related:
|
||||
- /influxdb/v2.0/users/
|
||||
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
|
||||
- /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
|
||||
- /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
|
||||
canonical: /{{< latest "influxdb" "v2" >}}/reference/cli/influx/user/
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,8 @@ menu:
|
|||
weight: 101
|
||||
cascade:
|
||||
related:
|
||||
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
|
||||
- /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
|
||||
- /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
|
||||
---
|
||||
|
||||
The `influx v1` command provides commands for working with the [InfluxDB 1.x compatibility API](/influxdb/v2.0/reference/api/influxdb-1x/) in InfluxDB 2.0.
|
||||
|
|
|
|||
|
|
@ -16,7 +16,8 @@ cascade:
|
|||
- /influxdb/v2.0/reference/syntax/line-protocol/
|
||||
- /influxdb/v2.0/reference/syntax/annotated-csv/
|
||||
- /influxdb/v2.0/reference/syntax/annotated-csv/extended/
|
||||
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
|
||||
- /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
|
||||
- /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
|
||||
---
|
||||
|
||||
The `influx write` command writes data to InfluxDB via stdin or from a specified file.
|
||||
|
|
|
|||
Loading…
Reference in New Issue