Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge branch 'master' into dbrp-mapping-fixes

pull/1575/head
kelseiv 2020-10-07 13:06:17 -07:00 committed by GitHub
parent a34a45d5cf 864b1f31cb
commit 63690d4918
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
202 changed files with 2227 additions and 989 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@ -10,6 +10,8 @@ What constitutes a "substantial" change is at the discretion of InfluxData docum
_**Note:** Typo and broken link fixes are greatly appreciated and do not require signing the CLA._
*If it's your first time contributing and you're looking for an easy update, check out our [good-first-issues](https://github.com/influxdata/docs-v2/issues?q=is%3Aissue+is%3Aopen+label%3Agood-first-issue)!*
## Make suggested updates
### Fork and clone InfluxData Documentation Repository
@ -678,7 +680,7 @@ When a user selects an InfluxDB product and region, example URLs in code blocks
throughout the documentation are updated to match their product and region.
InfluxDB URLs are configured in `/data/influxdb_urls.yml`.
By default, the InfluxDB URL replaced inside of code blocks is `http://localhost:9999`.
By default, the InfluxDB URL replaced inside of code blocks is `http://localhost:8086`.
Use this URL in all code examples that should be updated with a selected provider and region.
For example:
@ -686,14 +688,14 @@ For example:
~~~
```sh
# This URL will get updated
http://localhost:9999
http://localhost:8086
# This URL will NOT get updated
http://example.com
```
~~~
If the user selects the **US West (Oregon)** region, all occurrences of `http://localhost:9999`
If the user selects the **US West (Oregon)** region, all occurrences of `http://localhost:8086`
in code blocks will get updated to `https://us-west-2-1.aws.cloud2.influxdata.com`.
### Exempt URLs from getting updated
@ -704,7 +706,7 @@ just before the code block.
{{< keep-url >}}
```
// This URL won't get updated
http://localhost:9999
http://localhost:8086
```
~~~

279
api-docs/v2.0/swagger.yml
View File

@ -1283,47 +1283,6 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/Error"
patch:
operationId: PatchScrapersIDLabelsID
tags:
- ScraperTargets
summary: Update a label on a scraper target
parameters:
- $ref: "#/components/parameters/TraceSpan"
- in: path
name: scraperTargetID
schema:
type: string
required: true
description: The scraper target ID.
- in: path
name: labelID
schema:
type: string
required: true
description: The label ID.
requestBody:
description: Label update to apply
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/Label"
responses:
"200":
description: Updated successfully
"404":
description: Scraper target not found
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
default:
description: Unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"/scrapers/{scraperTargetID}/members":
get:
operationId: GetScrapersIDMembers
@ -2433,6 +2392,9 @@ paths:
summary: Get all dashboards
parameters:
- $ref: "#/components/parameters/TraceSpan"
- $ref: "#/components/parameters/Offset"
- $ref: "#/components/parameters/Limit"
- $ref: "#/components/parameters/Descending"
- in: query
name: owner
description: The owner ID.
@ -3504,6 +3466,7 @@ paths:
- $ref: "#/components/parameters/TraceSpan"
- $ref: "#/components/parameters/Offset"
- $ref: "#/components/parameters/Limit"
- $ref: "#/components/parameters/After"
- in: query
name: org
description: The organization name.
@ -3940,6 +3903,9 @@ paths:
summary: List all organizations
parameters:
- $ref: "#/components/parameters/TraceSpan"
- $ref: "#/components/parameters/Offset"
- $ref: "#/components/parameters/Limit"
- $ref: "#/components/parameters/Descending"
- in: query
name: org
schema:
@ -4338,6 +4304,36 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/Error"
"/orgs/{orgID}/owners/{userID}":
delete:
operationId: DeleteOrgsIDOwnersID
tags:
- Users
- Organizations
summary: Remove an owner from an organization
parameters:
- $ref: "#/components/parameters/TraceSpan"
- in: path
name: userID
schema:
type: string
required: true
description: The ID of the owner to remove.
- in: path
name: orgID
schema:
type: string
required: true
description: The organization ID.
responses:
"204":
description: Owner removed
default:
description: Unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/stacks:
get:
operationId: ListStacks
@ -4483,7 +4479,7 @@ paths:
type: string
templateMetaName:
type: string
required: ["kind","resourceID"]
required: ["kind", "resourceID"]
responses:
"200":
description: Influx stack updated
@ -4606,7 +4602,9 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/TemplateExport"
oneOf:
- $ref: "#/components/schemas/TemplateExportByID"
- $ref: "#/components/schemas/TemplateExportByName"
responses:
"200":
description: InfluxDB template created
@ -6520,6 +6518,15 @@ components:
required: false
schema:
type: string
After:
in: query
name: after
required: false
schema:
type: string
description: >
The last resource ID from which to seek from (but not including).
This is to be used instead of `offset`.
schemas:
LanguageRequest:
description: Flux query to be analyzed.
@ -7017,15 +7024,15 @@ components:
maxLength: 1
minLength: 1
annotations:
description: Https://www.w3.org/TR/2015/REC-tabular-data-model-20151217/#columns
description: https://www.w3.org/TR/2015/REC-tabular-data-model-20151217/#columns
type: array
uniqueItems: true
items:
type: string
enum:
- "group"
- "datatype"
- "default"
uniqueItems: true
commentPrefix:
description: Character prefixed to comment strings
type: string
@ -7121,7 +7128,7 @@ components:
description: ID of org that authorization is scoped to.
permissions:
type: array
minLength: 1
minItems: 1
description: List of permissions for an auth. An auth must have at least one Permission.
items:
$ref: "#/components/schemas/Permission"
@ -7470,7 +7477,7 @@ components:
- Task
- Telegraf
- Variable
TemplateExport:
TemplateExportByID:
type: object
properties:
stackID:
@ -7502,7 +7509,39 @@ components:
$ref: "#/components/schemas/TemplateKind"
name:
type: string
description: "if defined with id, name is used for resource exported by id. if defined independently, resources strictly matching name are exported"
required: [id, kind]
TemplateExportByName:
type: object
properties:
stackID:
type: string
orgIDs:
type: array
items:
type: object
properties:
orgID:
type: string
resourceFilters:
type: object
properties:
byLabel:
type: array
items:
type: string
byResourceKind:
type: array
items:
$ref: "#/components/schemas/TemplateKind"
resources:
type: object
properties:
kind:
$ref: "#/components/schemas/TemplateKind"
name:
type: string
required: [name, kind]
Template:
type: array
items:
@ -8951,9 +8990,73 @@ components:
enum: [overlaid, stacked]
geom:
$ref: "#/components/schemas/XYGeom"
legendOpacity:
type: number
format: float
legendOrientationThreshold:
type: integer
XYGeom:
type: string
enum: [line, step, stacked, bar, monotoneX]
BandViewProperties:
type: object
required:
- type
- geom
- queries
- shape
- axes
- colors
- legend
- note
- showNoteWhenEmpty
properties:
timeFormat:
type: string
type:
type: string
enum: [band]
queries:
type: array
items:
$ref: "#/components/schemas/DashboardQuery"
colors:
description: Colors define color encoding of data into a visualization
type: array
items:
$ref: "#/components/schemas/DashboardColor"
shape:
type: string
enum: ["chronograf-v2"]
note:
type: string
showNoteWhenEmpty:
description: If true, will display note when empty
type: boolean
axes:
$ref: "#/components/schemas/Axes"
legend:
$ref: "#/components/schemas/Legend"
xColumn:
type: string
yColumn:
type: string
upperColumn:
type: string
mainColumn:
type: string
lowerColumn:
type: string
hoverDimension:
type: string
enum: [auto, x, y, xy]
geom:
$ref: "#/components/schemas/XYGeom"
legendOpacity:
type: number
format: float
legendOrientationThreshold:
type: integer
LinePlusSingleStatProperties:
type: object
required:
@ -9014,6 +9117,11 @@ components:
type: string
decimalPlaces:
$ref: "#/components/schemas/DecimalPlaces"
legendOpacity:
type: number
format: float
legendOrientationThreshold:
type: integer
MosaicViewProperties:
type: object
required:
@ -9089,6 +9197,11 @@ components:
type: string
ySuffix:
type: string
legendOpacity:
type: number
format: float
legendOrientationThreshold:
type: integer
ScatterViewProperties:
type: object
required:
@ -9167,6 +9280,11 @@ components:
type: string
ySuffix:
type: string
legendOpacity:
type: number
format: float
legendOrientationThreshold:
type: integer
HeatmapViewProperties:
type: object
required:
@ -9238,6 +9356,11 @@ components:
type: string
binSize:
type: number
legendOpacity:
type: number
format: float
legendOrientationThreshold:
type: integer
SingleStatViewProperties:
type: object
required:
@ -9286,6 +9409,11 @@ components:
$ref: "#/components/schemas/Legend"
decimalPlaces:
$ref: "#/components/schemas/DecimalPlaces"
legendOpacity:
type: number
format: float
legendOrientationThreshold:
type: integer
HistogramViewProperties:
type: object
required:
@ -9340,6 +9468,11 @@ components:
enum: [overlaid, stacked]
binCount:
type: integer
legendOpacity:
type: number
format: float
legendOrientationThreshold:
type: integer
GaugeViewProperties:
type: object
required:
@ -9502,6 +9635,11 @@ components:
type: array
items:
$ref: "#/components/schemas/DashboardColor"
legendOpacity:
type: number
format: float
legendOrientationThreshold:
type: integer
Axes:
description: The viewport for a View's visualizations
type: object
@ -9672,6 +9810,7 @@ components:
- $ref: "#/components/schemas/ScatterViewProperties"
- $ref: "#/components/schemas/HeatmapViewProperties"
- $ref: "#/components/schemas/MosaicViewProperties"
- $ref: "#/components/schemas/BandViewProperties"
View:
required:
- name
@ -10794,7 +10933,7 @@ components:
example: { "color": "ffb3b3", "description": "this is a description" }
LabelCreateRequest:
type: object
required: [orgID]
required: [orgID, name]
properties:
orgID:
type: string
@ -11169,6 +11308,7 @@ components:
- $ref: "#/components/schemas/SMTPNotificationRule"
- $ref: "#/components/schemas/PagerDutyNotificationRule"
- $ref: "#/components/schemas/HTTPNotificationRule"
- $ref: "#/components/schemas/TelegramNotificationRule"
discriminator:
propertyName: type
mapping:
@ -11176,6 +11316,7 @@ components:
smtp: "#/components/schemas/SMTPNotificationRule"
pagerduty: "#/components/schemas/PagerDutyNotificationRule"
http: "#/components/schemas/HTTPNotificationRule"
telegram: "#/components/schemas/TelegramNotificationRule"
NotificationRule:
allOf:
- $ref: "#/components/schemas/NotificationRuleDiscriminator"
@ -11377,6 +11518,31 @@ components:
enum: [pagerduty]
messageTemplate:
type: string
TelegramNotificationRule:
allOf:
- $ref: "#/components/schemas/NotificationRuleBase"
- $ref: "#/components/schemas/TelegramNotificationRuleBase"
TelegramNotificationRuleBase:
type: object
required: [type, messageTemplate, channel]
properties:
type:
description: The discriminator between other types of notification rules is "telegram".
type: string
enum: [telegram]
messageTemplate:
description: The message template as a flux interpolated string.
type: string
parseMode:
description: Parse mode of the message text per https://core.telegram.org/bots/api#formatting-options . Defaults to "MarkdownV2" .
type: string
enum:
- MarkdownV2
- HTML
- Markdown
disableWebPagePreview:
description: Disables preview of web links in the sent messages when "true". Defaults to "false" .
type: boolean
NotificationEndpointUpdate:
type: object
@ -11395,12 +11561,14 @@ components:
- $ref: "#/components/schemas/SlackNotificationEndpoint"
- $ref: "#/components/schemas/PagerDutyNotificationEndpoint"
- $ref: "#/components/schemas/HTTPNotificationEndpoint"
- $ref: "#/components/schemas/TelegramNotificationEndpoint"
discriminator:
propertyName: type
mapping:
slack: "#/components/schemas/SlackNotificationEndpoint"
pagerduty: "#/components/schemas/PagerDutyNotificationEndpoint"
http: "#/components/schemas/HTTPNotificationEndpoint"
telegram: "#/components/schemas/TelegramNotificationEndpoint"
NotificationEndpoint:
allOf:
- $ref: "#/components/schemas/NotificationEndpointDiscrimator"
@ -11519,9 +11687,22 @@ components:
description: Customized headers.
additionalProperties:
type: string
TelegramNotificationEndpoint:
type: object
allOf:
- $ref: "#/components/schemas/NotificationEndpointBase"
- type: object
required: [token, channel]
properties:
token:
description: Specifies the Telegram bot token. See https://core.telegram.org/bots#creating-a-new-bot .
type: string
channel:
description: ID of the telegram channel, a chat_id in https://core.telegram.org/bots/api#sendmessage .
type: string
NotificationEndpointType:
type: string
enum: ["slack", "pagerduty", "http"]
enum: ["slack", "pagerduty", "http", "telegram"]
DBRP:
required:
- orgID

31
assets/js/influxdb-url.js
View File

@ -1,7 +1,8 @@
var defaultUrl = "http://localhost:9999"
var defaultUrl = "http://localhost:8086"
var placeholderCloudUrl = "https://cloud2.influxdata.com"
var defaultCloudUrl = "https://us-west-2-1.aws.cloud2.influxdata.com"
var elementSelector = ".article--content pre:not(.preserve)"
var isInfluxDBv1 = /influxdb\/v1/.test(window.location.href)
// Retrieve the selected URL from the influxdb_url session cookie
function getUrl() {
@ -25,23 +26,29 @@ function getPrevUrl() {
}
// Iterate through code blocks and update InfluxDB urls
// Ignore URLs in InfluxDB 1.x docs
function updateUrls(currentUrl, newUrl) {
if (typeof currentUrl != newUrl) {
$(elementSelector).each(function() {
$(this).html($(this).html().replace(currentUrl, newUrl));
});
if (!isInfluxDBv1) {
if (typeof currentUrl != newUrl) {
$(elementSelector).each(function() {
$(this).html($(this).html().replace(currentUrl, newUrl));
});
}
}
}
// Append the URL selector button to each codeblock with an InfluxDB URL
// Ignore codeblocks on InfluxDB v1.x pages
function appendUrlSelector(currentUrl, selectorText) {
$(elementSelector).each(function() {
var code = $(this).html()
if (code.includes(currentUrl)) {
$(this).after("<div class='select-url'><a class='url-trigger' href='#'>" + selectorText + "</a></div>")
$('.select-url').fadeIn(400)
}
});
if (!isInfluxDBv1) {
$(elementSelector).each(function() {
var code = $(this).html()
if (code.includes(currentUrl)) {
$(this).after("<div class='select-url'><a class='url-trigger' href='#'>" + selectorText + "</a></div>")
$('.select-url').fadeIn(400)
}
});
}
}
// Toggle the URL selector modal window

46
assets/js/notifications.js Normal file
View File

@ -0,0 +1,46 @@
// Get notification cookie name
function notificationCookieName(el) {
return "influx-" + $(el).attr('id') + "-notification-seen"
}
// Show notifications that are within scope and haven't been ssen
function showNotifications() {
$('#docs-notifications > .notification').each(function() {
// Check if the path includes paths defined in the data-scope attribute
// of the notification html element
function inScope(path, scope) {
for(let i = 0; i < scope.length; i++){
if (path.includes(scope[i])) {
return true;
};
}
return false;
}
var scope = $(this).data('scope').split(',')
var pageInScope = inScope(window.location.pathname, scope)
var notificationCookie = Cookies.get( notificationCookieName(this) )
if (pageInScope && notificationCookie != 'true') {
$(this).show().animate({right: 0, opacity: 1}, 200, 'swing')
}
});
}
// Hide a notification and set cookie as true
function hideNotification(el) {
$(el).closest('.notification').animate({height: 0, opacity: 0}, 200, 'swing', function(){
$(this).hide();
Cookies.set(notificationCookieName(this), true);
});
}
// Show notifications on page load
showNotifications()
// Hide a notification and set see cookie to true
$('.close-notification').click(function(e) {
e.preventDefault();
hideNotification(this);
})

12
assets/styles/layouts/_article.scss
View File

@ -156,18 +156,6 @@
text-align: center;
padding: 1rem;
.oss:after {
content: 'beta';
display: inline-block;
position: relative;
font-style: italic;
font-size: .75em;
margin-left: .15rem;
padding: .1rem .4rem .12rem;
border-radius: 1rem;
border: 1px solid rgba($g20-white, .5);
top: -1px
}
}
}
}

13
assets/styles/layouts/_landing.scss
View File

@ -130,19 +130,6 @@
z-index: -1;
}
&.oss:after {
content: 'beta';
display: inline-block;
vertical-align: top;
font-style: italic;
font-size: .75em;
margin-left: .45rem;
padding: .1rem .4rem .12rem;
border-radius: 1rem;
border: 1px solid rgba($landing-btn-text, .5);
transition: border-color .2s;
}
&:hover {
&:before { opacity: 1; }
}

93
assets/styles/layouts/_notifications.scss Normal file
View File

@ -0,0 +1,93 @@
#docs-notifications {
position: fixed;
top: 10px;
right: 10px;
z-index: 100;
width: calc(100vw - 20px);
max-width: 500px;
transition: all .4s ease;
.notification {
display: none; // initial hidden state
right: -50px; // initial hidden state
opacity: 0; // initial hidden state
position: relative;
border-radius: $radius;
box-shadow: 2px 2px 6px rgba($g2-kevlar, .35);
.notification-content {
padding: 1.25rem 2.35rem .5rem 1.25rem;
margin-bottom: 10px;
font-size: .95rem;
color: $g20-white;
}
.close-notification {
position: absolute;
top: 8px;
right: 8px;
font-size: 1.1rem;
cursor: pointer;
transition: color .2s;
font-weight: bold;
color: rgba($g20-white, .5);
&:hover{ color: $g20-white }
}
&.note {
@include gradient($grad-GarageBand);
a:hover { color: $gr-gypsy; }
code { color: $gr-gypsy; background: rgba($gr-gypsy, .25); }
pre { background: rgba($gr-gypsy, .25); }
}
&.warn {
@include gradient($grad-FuyuPersimmon, 225deg);
a:hover { color: $r-basalt; }
code { color: #ffbbdd; background: rgba($r-basalt, .35); }
pre { background: rgba($r-basalt, .35); }
}
//////////// Basic HTML element styles for notification content ////////////
h1,h2,h3,h4,h5,h6 {
font-weight: 500;
margin: 1rem 0 .75rem;
&:first-child { margin-top: 0; }
}
h1,h2 { font-size: 1.5rem; }
h3 { font-size: 1.25rem; }
h4 { font-size: 1.1rem; }
h5 { font-size: 1rem; }
h6 { font-size: .95rem; font-style: italic; }
p,li { line-height: 1.4rem; }
p { margin: 0 0 .75rem; }
a {
font-weight: bold;
text-decoration: none;
color: $g20-white;
transition: color .2s;
}
ul,ol { padding-left: 1.5rem; }
code {
padding: .15rem .4rem;
border-radius: $radius;
font-weight: bold;
}
pre {
padding: 1rem;
border-radius: $radius;
overflow: scroll;
code { background: transparent !important; }
}
}
}

7
assets/styles/layouts/_url-selector.scss
View File

@ -227,12 +227,7 @@ td,label,li {
line-height: .75rem;
border-radius: 1rem;
}
&.beta:after {
content: 'beta';
color: $r-dreamsicle;
background: rgba($r-dreamsicle, .1);
border: 1px solid $r-dreamsicle;
}
}
label:after {

3
assets/styles/styles-default.scss
View File

@ -25,7 +25,8 @@
"layouts/error-page",
"layouts/url-selector",
"layouts/feature-callouts",
"layouts/v1-overrides";
"layouts/v1-overrides",
"layouts/notifications";
// Import Product-specifc color schemes
@import "product-overrides/telegraf",

1
assets/styles/tools/_color-palette.scss
View File

@ -138,6 +138,7 @@ $grad-PastelGothic: $p-comet, $b-laser;
$grad-GarageBand: $b-pool, $gr-rainforest;
$grad-LowDifficulty: $b-pool, $gr-honeydew;
$grad-DesertFestival: $r-curacao, $p-star;
$grad-FuyuPersimmon: $y-tiger, $r-fire;
$grad-SavannaHeat: $y-topaz, $r-ruby;
$grad-ScotchBonnet: $y-pineapple,$r-curacao;

1
content/chronograf/v1.6/administration/creating-connections.md
View File

@ -51,6 +51,7 @@ An `.src` files contains the details for a single InfluxDB connection.
Create a new file named `example.src` (the filename is arbitrary) and place it at Chronograf's `resource-path`.
All `.src` files should contain the following:
{{< keep-url >}}
```json
{
"id": "10000",

1
content/chronograf/v1.6/administration/managing-influxdb-users.md
View File

@ -65,6 +65,7 @@ Run the `curl` command below to create an admin user, replacing:
* `chronothan` with your own username
* `supersecret` with your own password (note that the password requires single quotes)
{{< keep-url >}}
```
~# curl -XPOST "http://localhost:8086/query" --data-urlencode "q=CREATE USER chronothan WITH PASSWORD 'supersecret' WITH ALL PRIVILEGES"
```

2
content/chronograf/v1.6/guides/live_leaderboard.md
View File

@ -187,6 +187,7 @@ max
Since we are writing data back to InfluxDB create a database `game` for our results.
{{< keep-url >}}
```
curl -G 'http://localhost:8086/query?' --data-urlencode 'q=CREATE DATABASE game'
```
@ -274,6 +275,7 @@ Hit the endpoint several times to see that the scores are updating once a second
Now, let's check InfluxDB to see our historical data.
{{< keep-url >}}
```bash
curl \
-G 'http://localhost:8086/query?db=game' \

3
content/chronograf/v1.6/guides/monitoring-influxenterprise-clusters.md
View File

@ -85,6 +85,7 @@ Because you enabled authentication, you must perform this step before moving on
Run the command below to create an admin user, replacing `chronothan` and `supersecret` with your own username and password.
Note that the password requires single quotes.
{{< keep-url >}}
```
~# curl -XPOST "http://localhost:8086/query" --data-urlencode "q=CREATE USER chronothan WITH PASSWORD 'supersecret' WITH ALL PRIVILEGES"
```
@ -173,6 +174,8 @@ Repeat steps one through four for each data node in your cluster.
Run the following command on your InfluxDB OSS instance to see if your Telegraf instances are successfully collecting and writing data.
Replace the `chronothan` and `supersecret` values with your actual username and password.
{{< keep-url >}}
```
~# curl -G "http://localhost:8086/query?db=telegraf&u=chronothan&p=supersecret&pretty=true" --data-urlencode "q=SHOW TAG VALUES FROM cpu WITH KEY=host"
```

1
content/chronograf/v1.7/administration/creating-connections.md
View File

@ -85,6 +85,7 @@ An `.src` files contains the details for a single InfluxDB connection.
Create a new file named `example.src` (the filename is arbitrary) and place it at Chronograf's `resource-path`.
All `.src` files should contain the following:
{{< keep-url >}}
```json
{
"id": "10000",

1
content/chronograf/v1.7/administration/managing-influxdb-users.md
View File

@ -64,6 +64,7 @@ Run the `curl` command below to create an admin user, replacing:
* `chronothan` with your own username
* `supersecret` with your own password (note that the password requires single quotes)
{{< keep-url >}}
```
~# curl -XPOST "http://localhost:8086/query" --data-urlencode "q=CREATE USER chronothan WITH PASSWORD 'supersecret' WITH ALL PRIVILEGES"
```

2
content/chronograf/v1.7/guides/live_leaderboard.md
View File

@ -187,6 +187,7 @@ max
Since we are writing data back to InfluxDB create a database `game` for our results.
{{< keep-url >}}
```
curl -G 'http://localhost:8086/query?' --data-urlencode 'q=CREATE DATABASE game'
```
@ -274,6 +275,7 @@ Hit the endpoint several times to see that the scores are updating once a second
Now, let's check InfluxDB to see our historical data.
{{< keep-url >}}
```bash
curl \
-G 'http://localhost:8086/query?db=game' \

3
content/chronograf/v1.7/guides/monitoring-influxenterprise-clusters.md
View File

@ -85,6 +85,7 @@ Because you enabled authentication, you must perform this step before moving on
Run the command below to create an admin user, replacing `chronothan` and `supersecret` with your own username and password.
Note that the password requires single quotes.
{{< keep-url >}}
```
~# curl -XPOST "http://localhost:8086/query" --data-urlencode "q=CREATE USER chronothan WITH PASSWORD 'supersecret' WITH ALL PRIVILEGES"
```
@ -173,6 +174,8 @@ Repeat steps one through four for each data node in your cluster.
Run the following command on your InfluxDB OSS instance to see if your Telegraf instances are successfully collecting and writing data.
Replace the `chronothan` and `supersecret` values with your actual username and password.
{{< keep-url >}}
```
~# curl -G "http://localhost:8086/query?db=telegraf&u=chronothan&p=supersecret&pretty=true" --data-urlencode "q=SHOW TAG VALUES FROM cpu WITH KEY=host"
```

1
content/chronograf/v1.8/administration/creating-connections.md
View File

@ -85,6 +85,7 @@ An `.src` files contains the details for a single InfluxDB connection.
Create a new file named `example.src` (the filename is arbitrary) and place it at Chronograf's `resource-path`.
All `.src` files should contain the following:
{{< keep-url >}}
```json
{
"id": "10000",

1
content/chronograf/v1.8/administration/managing-influxdb-users.md
View File

@ -66,6 +66,7 @@ Run the `curl` command below to create an admin user, replacing:
* `chronothan` with your own username
* `supersecret` with your own password (note that the password requires single quotes)
{{< keep-url >}}
```
~# curl -XPOST "http://localhost:8086/query" --data-urlencode "q=CREATE USER chronothan WITH PASSWORD 'supersecret' WITH ALL PRIVILEGES"
```

2
content/chronograf/v1.8/guides/live_leaderboard.md
View File

@ -187,6 +187,7 @@ max
Since we are writing data back to InfluxDB create a database `game` for our results.
{{< keep-url >}}
```
curl -G 'http://localhost:8086/query?' --data-urlencode 'q=CREATE DATABASE game'
```
@ -274,6 +275,7 @@ Hit the endpoint several times to see that the scores are updating once a second
Now, let's check InfluxDB to see our historical data.
{{< keep-url >}}
```bash
curl \
-G 'http://localhost:8086/query?db=game' \

2
content/chronograf/v1.8/guides/monitoring-influxenterprise-clusters.md
View File

@ -85,6 +85,7 @@ Because you enabled authentication, you must perform this step before moving on
Run the command below to create an admin user, replacing `chronothan` and `supersecret` with your own username and password.
Note that the password requires single quotes.
{{< keep-url >}}
```
~# curl -XPOST "http://localhost:8086/query" --data-urlencode "q=CREATE USER chronothan WITH PASSWORD 'supersecret' WITH ALL PRIVILEGES"
```
@ -199,6 +200,7 @@ $ influx
Replace the `chronothan` and `supersecret` values with your actual username and password.
{{< keep-url >}}
```
~# curl -G "http://localhost:8086/query?db=telegraf&u=chronothan&p=supersecret&pretty=true" --data-urlencode "q=SHOW TAG VALUES FROM cpu WITH KEY=host"
```

47
content/chronograf/v1.8/tools/chronograf-cli/_index.md
View File

@ -19,23 +19,22 @@ chronograf [flags]
## Chronograf service flags
| Flag | Description | Default | Env. Variable |
|-----------------------|-------------------------------------------------------------------------------------------|-----------------------------------------|--------------------|
| `--host` | IP the Chronograf service listens on | `0.0.0.0` | `$HOST` |
| `--port` | Port the Chronograf service listens on for insecure connections | `8888` | `$PORT` |
| `-b`,`--bolt-path` | File path to the BoltDB file | `./chronograf-v1.db` | `$BOLT_PATH` |
| `-c`,`--canned-path` | File path to the directory of canned dashboard files | `/usr/share/chronograf/canned` | `$CANNED_PATH` |
| `--resources-path` | Path to directory of canned dashboards, sources, Kapacitor connections, and organizations | `/usr/share/chronograf/resources` | `$RESOURCES_PATH` |
| `-b`, `--basepath` | URL path prefix under which all Chronograf routes will be mounted. | | `$BASE_PATH` |
| `--status-feed-url` | URL of JSON feed to display as a news feed on the client status page | `https://www.influxdata.com/feed/json` | `$STATUS_FEED_URL` |
| `-v`, `--version` | Displays the version of the Chronograf service | | |
| `-h`, `--host-page-disabled` | Disables the hosts page | | `$HOST_PAGE_DISABLED` |
| Flag | Description | Env. Variable |
|:-----------------------------|:------------------------------------------------------------------------------------------------------------------------------------------|:---------------------|
| `--host` | IP the Chronograf service listens on. By default, `0.0.0.0` | `$HOST` |
| `--port` | Port the Chronograf service listens on for insecure connections. By default, `8888` | `$PORT` |
| `-b`,`--bolt-path` | File path to the BoltDB file. By default, `./chronograf-v1.db` | `$BOLT_PATH` |
| `-c`,`--canned-path` | File path to the directory of canned dashboard files. By default, `/usr/share/chronograf/canned` | `$CANNED_PATH` |
| `--resources-path` | Path to directory of canned dashboards, sources, Kapacitor connections, and organizations. By default, `/usr/share/chronograf/resources` | `$RESOURCES_PATH` |
| `-b`, `--basepath` | URL path prefix under which all Chronograf routes will be mounted. | `$BASE_PATH` |
| `--status-feed-url` | URL of JSON feed to display as a news feed on the client status page. By default, `https://www.influxdata.com/feed/json` | `$STATUS_FEED_URL` |
| `-v`, `--version` | Displays the version of the Chronograf service | |
| `-h`, `--host-page-disabled` | Disables the hosts page | `$HOST_PAGE_DISABLED`|
## InfluxDB connection flags
| Flag | Description | Env. Variable |
|-----------------------|-------------------------------------------------------------------------------|----------------------|
|:----------------------|:------------------------------------------------------------------------------|:---------------------|
| `--influxdb-url` | Location of your InfluxDB instance, including `http://`, IP address, and port | `$INFLUXDB_URL` |
| `--influxdb-username` | Username for your InfluxDB instance | `$INFLUXDB_USERNAME` |
| `--influxdb-password` | Password for your InfluxDB instance | `$INFLUXDB_PASSWORD` |
@ -43,7 +42,7 @@ chronograf [flags]
## Kapacitor connection flags
| Flag | Description | Env. Variable |
|------------------------|--------------------------------------------------------------------------------|-----------------------|
|:-----------------------|:-------------------------------------------------------------------------------|:----------------------|
| `--kapacitor-url` | Location of your Kapacitor instance, including `http://`, IP address, and port | `$KAPACITOR_URL` |
| `--kapacitor-username` | Username for your Kapacitor instance | `$KAPACITOR_USERNAME` |
| `--kapacitor-password` | Password for your Kapacitor instance | `$KAPACITOR_PASSWORD` |
@ -51,15 +50,15 @@ chronograf [flags]
## TLS (Transport Layer Security) flags
| Flag | Description | Env. Variable |
|---------|------------------------------------------------------------|--------------------|
|:---------|:------------------------------------------------------------|:--------------------|
| `--cert` | File path to PEM-encoded public key certificate | `$TLS_CERTIFICATE` |
| `--key` | File path to private key associated with given certificate | `$TLS_PRIVATE_KEY` |
## Other service option flags
| Flag | Description | Env. Variable |
|----------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|
| `--custom-link` <display_name>:<link_address> | Custom link added to Chronograf user menu options. Useful for providing links to internal company resources for your Chronograf users. Can be used when any OAuth 2.0 authentication is enabled. To add another custom link, repeat the custom link option. | |
| Flag | Description | Env. Variable |
|:---------------------------------------------|:------------------------------------------------------------------------|:----------------------|
| `--custom-link` <display_name>:<link_address>| Custom link added to Chronograf user menu options. Useful for providing links to internal company resources for your Chronograf users. Can be used when any OAuth 2.0 authentication is enabled. To add another custom link, repeat the custom link option. | |
| `-r`, `--reporting-disabled` | Disables reporting of usage statistics. Usage statistics reported once every 24 hours include: `OS`, `arch`, `version`, `cluster_id`, and `uptime`. | `$REPORTING_DISABLED` |
| `-l`, `--log-level` | Sets the logging level. Valid values include `info` (default), `debug`, and `error`. | `$LOG_LEVEL` |
| `-d`, `--develop` | Runs the Chronograf service in developer mode | |
@ -70,7 +69,7 @@ chronograf [flags]
### General authentication flags
| Flag | Description | Env. Variable |
|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|
|:-----------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------|
| `-t`, `--token-secret` | Secret for signing tokens | `$TOKEN_SECRET` |
| `--auth-duration` | Total duration, in hours, of cookie life for authentication. Default value is `720h`. | `$AUTH_DURATION` |
| `--public-url` | Public URL required to access Chronograf using a web browser. For example, if you access Chronograf using the default URL, the public URL value would be `http://localhost:8888`. Required for Google OAuth 2.0 authentication. Used for Auth0 and some generic OAuth 2.0 authentication providers. | `$PUBLIC_URL` |
@ -78,7 +77,7 @@ chronograf [flags]
### GitHub-specific OAuth 2.0 authentication flags
| Flag | Description | Env. Variable |
|--------------------------------|-------------------------------------------------------------------------|---------------------|
|:-------------------------------|:------------------------------------------------------------------------|:--------------------|
| `-i`, `--github-client-id` | GitHub client ID value for OAuth 2.0 support | `$GH_CLIENT_ID` |
| `-s`, `--github-client-secret` | GitHub client secret value for OAuth 2.0 support | `$GH_CLIENT_SECRET` |
| `-o`, `--github-organization` | Specify a GitHub organization membership required for a user. Optional. | `$GH_ORGS` |
@ -86,7 +85,7 @@ chronograf [flags]
### Google-specific OAuth 2.0 authentication flags
| Flag | Description | Env. Variable |
|--------------------------|---------------------------------------------------------------------------------|-------------------------|
|:-------------------------|:--------------------------------------------------------------------------------|:------------------------|
| `--google-client-id` | Google client ID value for OAuth 2.0 support | `$GOOGLE_CLIENT_ID` |
| `--google-client-secret` | Google client secret value for OAuth 2.0 support | `$GOOGLE_CLIENT_SECRET` |
| `--google-domains` | Restricts authorization to users from specified Google email domains. Optional. | `$GOOGLE_DOMAINS` |
@ -95,7 +94,7 @@ chronograf [flags]
### Auth0-specific OAuth 2.0 authentication flags
| Flag | Description | Env. Variable |
|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|
|:------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------|
| `--auth0-domain` | Subdomain of your Auth0 client. Available on the configuration page for your Auth0 client. | `$AUTH0_DOMAIN` |
| `--auth0-client-id` | Auth0 client ID value for OAuth 2.0 support | `$AUTH0_CLIENT_ID` |
| `--auth0-client-secret` | Auth0 client secret value for OAuth 2.0 support | `$AUTH0_CLIENT_SECRET` |
@ -104,7 +103,7 @@ chronograf [flags]
### Heroku-specific OAuth 2.0 authentication flags
| Flag | Description | Env. Variable |
|-------------------------|------------------------------------------------------------------------------------------|---------------------|
|:------------------------|:-----------------------------------------------------------------------------------------|:--------------------|
| `--heroku-client-id` | Heroku client ID value for OAuth 2.0 support | `$HEROKU_CLIENT_ID` |
| `--heroku-secret` | Heroku secret for OAuth 2.0 support | `$HEROKU_SECRET` |
| `--heroku-organization` | Heroku organization membership required to access Chronograf. Lists are comma-separated. | `$HEROKU_ORGS` |
@ -112,7 +111,7 @@ chronograf [flags]
### Generic OAuth 2.0 authentication flags
| Flag | Description | Env. Variable |
|---------------------------|--------------------------------------------------------------------------------|--------------------------|
|:--------------------------|:-------------------------------------------------------------------------------|:-------------------------|
| `--generic-name` | Generic OAuth 2.0 name presented on the login page | `$GENERIC_NAME` |
| `--generic-client-id` | Generic OAuth 2.0 client ID value. Can be used for a custom OAuth 2.0 service. | `$GENERIC_CLIENT_ID` |
| `--generic-client-secret` | Generic OAuth 2.0 client secret value | `$GENERIC_CLIENT_SECRET` |

2
content/enterprise_influxdb/v1.8/administration/anti-entropy-api.md
View File

@ -17,7 +17,7 @@ Use the [Anti-Entropy service](/enterprise_influxdb/v1.8/administration/anti-ent
The base URL is:
```text
http://localhost:8086/shard-repair`
http://localhost:8086/shard-repair
```
## GET `/status`

1
content/enterprise_influxdb/v1.8/introduction/installation_requirements.md
View File

@ -5,6 +5,7 @@ aliases:
- /enterprise_influxdb/v1.8/introduction/meta_node_installation/
- /enterprise_influxdb/v1.8/introduction/data_node_installation/
- /enterprise/v1.8/introduction/installation_guidelines/
- /enterprise_influxdb/v1.8/introduction/installation_guidelines/
menu:
enterprise_influxdb_1_8:
weight: 20

2
content/influxdb/v1.5/supported_protocols/collectd.md
View File

@ -23,7 +23,7 @@ Each collectd input allows the binding address, target database, and target rete
Each collectd input also performs internal batching of the points it receives, as batched writes to the database are more efficient. The default batch size is 1000, pending batch factor is 5, with a batch timeout of 1 second. This means the input will write batches of maximum size 1000, but if a batch has not reached 1000 points within 1 second of the first point being added to a batch, it will emit that batch regardless of size. The pending batch factor controls how many batches can be in memory at once, allowing the input to transmit a batch, while still building other batches.
Multi-value plugins can be handled two ways. Setting parse-multivalue-plugin to "split" will parse and store the multi-value plugin data (e.g., df free:5000,used:1000) into separate measurements (e.g., (df_free, value=5000) (df_used, value=1000)), while "join" will parse and store the multi-value plugin as a single multi-value measurement (e.g., (df, free=5000,used=1000)). "split" is the default behavior for backward compatability with previous versions of influxdb.
Multi-value plugins can be handled two ways. Setting parse-multivalue-plugin to "split" will parse and store the multi-value plugin data (e.g., df free:5000,used:1000) into separate measurements (e.g., (df_free, value=5000) (df_used, value=1000)), while "join" will parse and store the multi-value plugin as a single multi-value measurement (e.g., (df, free=5000,used=1000)). "split" is the default behavior for backward compatibility with previous versions of influxdb.
The path to the collectd types database file may also be set.

2
content/influxdb/v1.7/flux/get-started/_index.md
View File

@ -98,7 +98,7 @@ are unique to each row.
## Tools for working with Flux
You have multiple [options for writing and running Flux queries](/{{< latest "influxdb" "v2" >}}/reference/flux/guides/executing-queries),
You have multiple [options for writing and running Flux queries](/influxdb/v1.7/flux/guides/execute-queries/),
but as you're getting started, we recommend using the following:
### 1. Chronograf's Data Explorer

4
content/influxdb/v1.7/flux/get-started/syntax-basics.md
View File

@ -187,7 +187,7 @@ topN = (tables=<-, n) =>
|> limit(n: n)
```
_More information about creating custom functions is available in the [Custom functions](/{{< latest "influxdb" "v2" >}}/reference/flux/stdlib/custom-functions) documentation._
_More information about creating custom functions is available in the [Custom functions](/{{< latest "influxdb" "v2" >}}/query-data/flux/custom-functions) documentation._
Using this new custom function `topN` and the `cpuUsageUser` data stream variable defined above,
find the top five data points and yield the results.
@ -220,7 +220,7 @@ Then using Flux's `sort()` and `limit()` functions to find the top `n` results i
topN = (tables=<-, n) => tables |> sort(desc: true) |> limit(n: n)
```
_More information about creating custom functions is available in the [Custom functions](/{{< latest "influxdb" "v2" >}}/reference/flux/stdlib/custom-functions) documentation._
_More information about creating custom functions is available in the [Custom functions](/{{< latest "influxdb" "v2" >}}/query-data/flux/custom-functions) documentation._
Using the `cpuUsageUser` data stream variable defined [above](#define-data-stream-variables),
find the top five data points with the custom `topN` function and yield the results.

2
content/influxdb/v1.7/flux/get-started/transform-data.md
View File

@ -38,7 +38,7 @@ from(bucket:"telegraf/autogen")
## Flux functions
Flux provides a number of functions that perform specific operations, transformations, and tasks.
You can also [create custom functions](/{{< latest "influxdb" "v2" >}}/reference/flux/stdlib/custom-functions) in your Flux queries.
You can also [create custom functions](/{{< latest "influxdb" "v2" >}}/query-data/flux/custom-functions) in your Flux queries.
_Functions are covered in detail in the [Flux functions](/{{< latest "influxdb" "v2" >}}/reference/flux/stdlib) documentation._
A common type of function used when transforming data queried from InfluxDB is an aggregate function.

6
content/influxdb/v1.7/flux/guides/window-aggregate.md
View File

@ -180,7 +180,7 @@ Table: keys: [_start, _stop, _field, _measurement]
When visualized in the InfluxDB UI, each window table is displayed in a different color.
![Windowed data](/img/simple-windowed-data.png)
![Windowed data](/img/flux/simple-windowed-data.png)
## Aggregate data
[Aggregate functions](/{{< latest "influxdb" "v2" >}}/reference/flux/stdlib/built-in/transformations/aggregates) take the values
@ -242,7 +242,7 @@ Table: keys: [_start, _stop, _field, _measurement]
Because each data point is contained in its own table, when visualized,
they appear as single, unconnected points.
![Aggregated windowed data](/img/simple-windowed-aggregate-data.png)
![Aggregated windowed data](/img/flux/simple-windowed-aggregate-data.png)
### Recreate the time column
**Notice the `_time` column is not in the [aggregated output tables](#mean-output-tables).**
@ -336,7 +336,7 @@ Table: keys: [_start, _stop, _field, _measurement]
With the aggregate values in a single table, data points in the visualization are connected.
![Unwindowed aggregate data](/img/simple-unwindowed-data.png)
![Unwindowed aggregate data](/img/flux/simple-unwindowed-data.png)
## Summing up
You have now created a Flux query that windows and aggregates data.

2
content/influxdb/v1.7/query_language/data_exploration.md
View File

@ -1072,7 +1072,7 @@ for details on the `time_interval`.
The `offset_interval` is a
[duration literal](/influxdb/v1.7/query_language/spec/#durations).
It shifts forward or back tje InfluxDB database's preset time boundaries.
It shifts forward or back the InfluxDB database's preset time boundaries.
The `offset_interval` can be positive or negative.
##### `fill(<fill_option>)`

15
content/influxdb/v1.8/about_the_project/releasenotes-changelog.md
View File

@ -9,6 +9,21 @@ menu:
v2: /influxdb/v2.0/reference/release-notes/influxdb/
---
## v1.8.3 [2020-09-30]
### Features
- Use latest version of InfluxQL package.
- Add `-lponly` flag to [`influx export`](/influxdb/v2.0/reference/cli/influx/export/).
- Add the ability to track number of values written via the [/debug/vars HTTP endpoint](/influxdb/v1.8/tools/api/#debug-vars-http-endpoint).
- Update UUID library from [github.com/satori/go.uuid](https://github.com/satori/go.uuid) to [github.com/gofrs/uuid](https://github.com/gofrs/uuid).
### Bug fixes
- ArrayFilterCursor truncation for multi-block data.
- Multi-measurement queries now return all applicable series.
- Lock map before writes.
## v1.8.2 [2020-08-13]
### Bug fixes

2
content/influxdb/v1.8/concepts/crosswalk.md
View File

@ -128,7 +128,7 @@ many of the outstanding feature requests that we've received since introducing I
For a comparison between Flux and InfluxQL, see [Flux vs InfluxQL](/influxdb/v1.8/flux/flux-vs-influxql/).
Flux is the primary language for working with data in [InfluxDB 2.0 OSS](/influxdb/v2.0/get-started)
(currently in _beta_) and [InfluxDB Cloud 2.0](/influxdb/v2.0/cloud/get-started/),
and [InfluxDB Cloud 2.0](/influxdb/v2.0/cloud/get-started/),
a generally available Platform as a Service (PaaS) available across multiple Cloud Service Providers.
Using Flux with InfluxDB 1.8+ lets you get familiar with Flux concepts and syntax
and ease the transition to InfluxDB 2.0.

2
content/influxdb/v1.8/flux/get-started/_index.md
View File

@ -99,7 +99,7 @@ are unique to each row.
## Tools for working with Flux
You have multiple [options for writing and running Flux queries](/{{< latest "influxdb" "v2" >}}/reference/flux/guides/executing-queries),
You have multiple [options for writing and running Flux queries](/influxdb/v1.8/flux/guides/execute-queries/),
but as you're getting started, we recommend using the following:
### 1. Chronograf's Data Explorer

4
content/influxdb/v1.8/flux/get-started/syntax-basics.md
View File

@ -187,7 +187,7 @@ topN = (tables=<-, n) =>
|> limit(n: n)
```
_More information about creating custom functions is available in the [Custom functions](/{{< latest "influxdb" "v2" >}}/reference/flux/stdlib/custom-functions) documentation._
_More information about creating custom functions is available in the [Custom functions](/{{< latest "influxdb" "v2" >}}/query-data/flux/custom-functions) documentation._
Using this new custom function `topN` and the `cpuUsageUser` data stream variable defined above,
find the top five data points and yield the results.
@ -220,7 +220,7 @@ Then using Flux's `sort()` and `limit()` functions to find the top `n` results i
topN = (tables=<-, n) => tables |> sort(desc: true) |> limit(n: n)
```
_More information about creating custom functions is available in the [Custom functions](/{{< latest "influxdb" "v2" >}}/reference/flux/stdlib/custom-functions) documentation._
_More information about creating custom functions is available in the [Custom functions](/{{< latest "influxdb" "v2" >}}/query-data-/flux/custom-functions) documentation._
Using the `cpuUsageUser` data stream variable defined [above](#define-data-stream-variables),
find the top five data points with the custom `topN` function and yield the results.

2
content/influxdb/v1.8/flux/get-started/transform-data.md
View File

@ -38,7 +38,7 @@ from(bucket:"telegraf/autogen")
## Flux functions
Flux provides a number of functions that perform specific operations, transformations, and tasks.
You can also [create custom functions](/{{< latest "influxdb" "v2" >}}/reference/flux/stdlib/custom-functions) in your Flux queries.
You can also [create custom functions](/{{< latest "influxdb" "v2" >}}/query-data/flux/custom-functions) in your Flux queries.
_Functions are covered in detail in the [Flux functions](/{{< latest "influxdb" "v2" >}}/reference/flux/stdlib) documentation._
A common type of function used when transforming data queried from InfluxDB is an aggregate function.

6
content/influxdb/v1.8/flux/guides/window-aggregate.md
View File

@ -180,7 +180,7 @@ Table: keys: [_start, _stop, _field, _measurement]
When visualized in the InfluxDB UI, each window table is displayed in a different color.
![Windowed data](/img/simple-windowed-data.png)
![Windowed data](/img/flux/simple-windowed-data.png)
## Aggregate data
[Aggregate functions](/{{< latest "influxdb" "v2" >}}/reference/flux/stdlib/built-in/transformations/aggregates) take the values
@ -242,7 +242,7 @@ Table: keys: [_start, _stop, _field, _measurement]
Because each data point is contained in its own table, when visualized,
they appear as single, unconnected points.
![Aggregated windowed data](/img/simple-windowed-aggregate-data.png)
![Aggregated windowed data](/img/flux/simple-windowed-aggregate-data.png)
### Recreate the time column
**Notice the `_time` column is not in the [aggregated output tables](#mean-output-tables).**
@ -336,7 +336,7 @@ Table: keys: [_start, _stop, _field, _measurement]
With the aggregate values in a single table, data points in the visualization are connected.
![Unwindowed aggregate data](/img/simple-unwindowed-data.png)
![Unwindowed aggregate data](/img/flux/simple-unwindowed-data.png)
## Summing up
You have now created a Flux query that windows and aggregates data.

4
content/influxdb/v1.8/introduction/install.md
View File

@ -240,13 +240,13 @@ If `gpg` is not available, see the [GnuPG homepage](https://gnupg.org/download/)
For example:
```
wget https://dl.influxdata.com/influxdb/releases/influxdb-1.8.0_linux_amd64.tar.gz.asc
wget https://dl.influxdata.com/influxdb/releases/influxdb-1.8.3_linux_amd64.tar.gz.asc
```
3. Verify the signature with `gpg --verify`:
```
gpg --verify influxdb-1.8.0_linux_amd64.tar.gz.asc influxdb-1.8.0_linux_amd64.tar.gz
gpg --verify influxdb-1.8.3_linux_amd64.tar.gz.asc influxdb-1.8.3_linux_amd64.tar.gz
```
The output from this command should include the following:

4
content/influxdb/v1.8/tools/influx_inspect.md
View File

@ -370,6 +370,10 @@ YYYY-MM-DDTHH:MM:SS+07:00
> **Note:** With offsets, avoid replacing the + or - sign with a Z. It may cause an error or print Z (ISO 8601 behavior) instead of the time zone offset.
##### [ `-lponly` ]
Output data in line protocol format only.
Does not include comments or data definition language (DDL), like `CREATE DATABASE`.
##### [ `-out <export_dir>` ]
The location for the export file.

33
content/influxdb/v1.8/troubleshooting/systemd.md Normal file
View File

@ -0,0 +1,33 @@
---
title: Troubleshoot systemd errors
list_title: systemd permission errors
description: Troubleshoot errors with InfluxDB and systemd permissions
menu:
platform:
name: systemd errors
parent: Troubleshoot
weight: 1
---
When running InfluxDB using systemd (Ubuntu, Debian, CentOS), you might encounter errors in the InfluxDB logs (via `journalctl -u influxdb`) like:
- `error msg="Unable to open series file"`
- `run: open server: open tsdb store: mkdir /var/lib/influxdb/data/_internal/_series/00: permission denied`
When InfluxDB is installed with systemd, an `influxdb` user and group is automatically created.
If the user runs an `influxd` process directly from their login shell, it can generate new series files not accessible by the `influxdb` user.
In this case, when systemd starts the InfluxDB service (via `sudo systemctl start influxdb`),
the InfluxDB process will exit because it cannot access the leftover files owned by the `root` user.
To resolve this issue, set all files in the InfluxDB directories to be owned by the `influxdb` user and group.
Run the following command:
```
sudo chown -R influxdb:influxdb /var/lib/influxdb/*
```
Alternatively, if the data is not important, reset the database by removing all files:
```
sudo rm -rf /var/lib/influxdb/
```

16
content/influxdb/v2.0/backup-restore/backup.md
View File

@ -19,9 +19,19 @@ InfluxDB copies all data and metadata to a set of files stored in a specified di
on your local filesystem.
{{% warn %}}
If you set up InfluxDB using **v2.0.0-beta.1** or earlier, you cannot back up data.
Root tokens created prior to **v2.0.0-beta.2** do not have the necessary permissions.
To succesfully use the backup tool, set up a new InfluxDB instance using **v2.0.0-beta.2+**.
#### InfluxDB 2.0rc0
The `influx backup` command is not compatible with InfluxDB 2.0rc0.
To backup data,
1. Stop `influxd`.
2. Manually copy the InfluxDB data directories:
```
cp -r ~/.influxdbv2 ~/.influxdbv2_bak
```
For more information, see [Upgrade to InfluxDB OSS 2.0rc0](/influxdb/v2.0/reference/rc0-upgrade-guide/).
{{% /warn %}}
{{% cloud %}}

74
content/influxdb/v2.0/get-started.md
View File

@ -13,8 +13,7 @@ aliases:
The InfluxDB 2.0 time series platform is purpose-built to collect, store,
process and visualize metrics and events.
Start with **InfluxDB Cloud 2.0**, a fully managed and hosted version of InfluxDB 2.0,
or **InfluxDB OSS 2.0 _(beta)_**, the open source
version of InfluxDB 2.0.
or **InfluxDB OSS 2.0**, the open source version of InfluxDB 2.0.
<div class="get-started-btns">
<a class="btn" href="#start-with-influxdb-cloud-2-0">Start with InfluxDB Cloud</a>
@ -84,7 +83,7 @@ Currently, we do **not support** using an existing InfluxDB Cloud 2.0 account to
{{% cloud %}}
All InfluxDB 2.0 documentation applies to {{< cloud-name "short" >}} unless otherwise specified.
References to the InfluxDB user interface (UI) or localhost:9999 refer to your
References to the InfluxDB user interface (UI) or localhost:8086 refer to your
{{< cloud-name >}} UI.
{{% /cloud %}}
@ -105,7 +104,7 @@ To use the `influx` CLI to manage and interact with your InfluxDB Cloud instance
Click the following button to download and install `influx` CLI for macOS.
<a class="btn download" href="https://dl.influxdata.com/influxdb/releases/influxdb_client_2.0.0-beta.16_darwin_amd64.tar.gz" download>influx CLI (macOS)</a>
<a class="btn download" href="https://dl.influxdata.com/influxdb/releases/influxdb-2.0.0-rc.0_darwin_amd64.tar.gz" download>influx CLI (macOS)</a>
#### Step 2: Unpackage the influx binary
@ -117,7 +116,7 @@ or run the following command in a macOS command prompt application such
```sh
# Unpackage contents to the current working directory
tar zxvf ~/Downloads/influxdb_client_2.0.0-beta.16_darwin_amd64.tar.gz
tar zxvf ~/Downloads/influxdb-2.0.0-rc.0_darwin_amd64.tar.gz
```
#### Step 3: (Optional) Place the binary in your $PATH
@ -129,7 +128,7 @@ prefix the executable with `./` to run in place. If the binary is on your $PATH,
```sh
# Copy the influx binary to your $PATH
sudo cp influxdb_client_2.0.0-beta.16_darwin_amd64/influx /usr/local/bin/
sudo cp influxdb-2.0.0-rc.0_darwin_amd64/influx /usr/local/bin/
```
{{% note %}}
@ -149,7 +148,7 @@ In a terminal, run the following command:
```sh
# Set up a configuration profile
influx config create -n default \
-u http://localhost:9999 \
-u http://localhost:8086 \
-o example-org \
-t mySuP3rS3cr3tT0keN \
-a
@ -170,10 +169,9 @@ To see all available `influx` commands, type `influx -h` or check out [influx -
#### Step 1: Download influx CLI for Linux
Click one of the following buttons to download and install the `influx` CLI appropriate for your chipset.
Download and install the `influx` CLI for Linux.
<a class="btn download" href="https://dl.influxdata.com/influxdb/releases/influxdb_client_2.0.0-beta.16_linux_amd64.tar.gz" download >influx CLI (amd64)</a>
<a class="btn download" href="https://dl.influxdata.com/influxdb/releases/influxdb_client_2.0.0-beta.16_linux_arm64.tar.gz" download >influx CLI (arm)</a>
<a class="btn download" href="https://dl.influxdata.com/influxdb/releases/influxdb_client_2.0.0-rc.0_linux_amd64.tar.gz" download >influx CLI (amd64)</a>
#### Step 2: Unpackage the influx binary
@ -181,7 +179,7 @@ Click one of the following buttons to download and install the `influx` CLI appr
```sh
# Unpackage contents to the current working directory
tar xvfz influxdb_client_2.0.0-beta.16_linux_amd64.tar.gz
tar xvfz influxdb_client_2.0.0-rc.0_linux_amd64.tar.gz
```
#### Step 3: (Optional) Place the binary in your $PATH
@ -193,7 +191,7 @@ prefix the executable with `./` to run in place. If the binary is on your $PATH,
```sh
# Copy the influx and influxd binary to your $PATH
sudo cp influxdb_client_2.0.0-beta.16_linux_amd64/influx /usr/local/bin/
sudo cp influxdb_client_2.0.0-rc.0_linux_amd64/influx /usr/local/bin/
```
{{% note %}}
@ -209,7 +207,7 @@ In a terminal, run the following command:
```sh
# Set up a configuration profile
influx config create -n default \
-u http://localhost:9999 \
-u http://localhost:8086 \
-o example-org \
-t mySuP3rS3cr3tT0keN \
-a
@ -245,6 +243,10 @@ With {{< cloud-name "short" >}} setup, see [Next steps](#next-steps) for what to
Get started with InfluxDB OSS v2.0 by downloading InfluxDB, installing the necessary
executables, and running the initial setup process.
{{% note %}}
To upgrade from InfluxDB 2.0 beta 16 or earlier to the latest version, see [Upgrade to InfluxDB OSS 2.0rc0](/influxdb/v2.0/reference/rc0-upgrade-guide/).
{{% /note %}}
{{< tabs-wrapper >}}
{{% tabs %}}
[macOS](#)
@ -255,11 +257,11 @@ executables, and running the initial setup process.
<!-------------------------------- BEGIN macOS -------------------------------->
{{% tab-content %}}
### Download and install InfluxDB v2.0 beta
### Download and install InfluxDB v2.0
Download InfluxDB v2.0 beta for macOS.
Download InfluxDB v2.0 for macOS.
<a class="btn download" href="https://dl.influxdata.com/influxdb/releases/influxdb_2.0.0-beta.16_darwin_amd64.tar.gz" download>InfluxDB v2.0 beta (macOS)</a>
<a class="btn download" href="https://dl.influxdata.com/influxdb/releases/influxdb-2.0.0-rc.0_darwin_amd64.tar.gz" download>InfluxDB v2.0 (macOS)</a>
### Unpackage the InfluxDB binaries
@ -269,7 +271,7 @@ or run the following command in a macOS command prompt application such
```sh
# Unpackage contents to the current working directory
tar zxvf ~/Downloads/influxdb_2.0.0-beta.16_darwin_amd64.tar.gz
tar zxvf ~/Downloads/influxdb-2.0.0-rc.0_darwin_amd64.tar.gz
```
#### (Optional) Place the binaries in your $PATH
@ -279,7 +281,7 @@ prefix the executables with `./` to run then in place.
```sh
# (Optional) Copy the influx and influxd binary to your $PATH
sudo cp influxdb_2.0.0-beta.16_darwin_amd64/{influx,influxd} /usr/local/bin/
sudo cp influxdb-2.0.0-rc.0_darwin_amd64/{influx,influxd} /usr/local/bin/
```
{{% note %}}
@ -291,7 +293,7 @@ If you rename the binaries, all references to `influx` and `influxd` in this doc
#### Networking ports
By default, InfluxDB uses TCP port `9999` for client-server communication over
By default, InfluxDB uses TCP port `8086` for client-server communication over
the [InfluxDB HTTP API](/influxdb/v2.0/reference/api/).
### Start InfluxDB
@ -344,12 +346,11 @@ influxd --reporting-disabled
<!-------------------------------- BEGIN Linux -------------------------------->
{{% tab-content %}}
### Download and install InfluxDB v2.0 beta
### Download and install InfluxDB v2.0
Download the InfluxDB v2.0 beta package appropriate for your chipset.
Download InfluxDB v2.0 for Linux.
<a class="btn download" href="https://dl.influxdata.com/influxdb/releases/influxdb_2.0.0-beta.16_linux_amd64.tar.gz" download >InfluxDB v2.0 beta (amd64)</a>
<a class="btn download" href="https://dl.influxdata.com/influxdb/releases/influxdb_2.0.0-beta.16_linux_arm64.tar.gz" download >InfluxDB v2.0 beta (arm)</a>
<a class="btn download" href="https://dl.influxdata.com/influxdb/releases/influxdb-2.0.0-rc.0_linux_amd64.tar.gz" download >InfluxDB v2.0 (amd64)</a>
### Place the executables in your $PATH
@ -359,10 +360,10 @@ _**Note:** The following commands are examples. Adjust the file names, paths, an
```sh
# Unpackage contents to the current working directory
tar xvzf path/to/influxdb_2.0.0-beta.16_linux_amd64.tar.gz
tar xvzf path/to/influxdb-2.0.0-rc.0_linux_amd64.tar.gz
# Copy the influx and influxd binary to your $PATH
sudo cp influxdb_2.0.0-beta.16_linux_amd64/{influx,influxd} /usr/local/bin/
sudo cp influxdb-2.0.0-rc.0_linux_amd64.tar.gz/{influx,influxd} /usr/local/bin/
```
{{% note %}}
@ -374,7 +375,7 @@ If you rename the binaries, all references to `influx` and `influxd` in this doc
#### Networking ports
By default, InfluxDB uses TCP port `9999` for client-server communication over
By default, InfluxDB uses TCP port `8086` for client-server communication over
the [InfluxDB HTTP API](/influxdb/v2.0/reference/api/).
### Start InfluxDB
@ -412,14 +413,14 @@ influxd --reporting-disabled
<!-------------------------------- BEGIN Docker ------------------------------->
{{% tab-content %}}
### Download and run InfluxDB v2.0 beta
### Download and run InfluxDB v2.0
Use `docker run` to download and run the InfluxDB v2.0 beta Docker image.
Expose port `9999`, which InfluxDB uses for client-server communication over
Use `docker run` to download and run the InfluxDB v2.0 Docker image.
Expose port `8086`, which InfluxDB uses for client-server communication over
the [InfluxDB HTTP API](/influxdb/v2.0/reference/api/).
```sh
docker run --name influxdb -p 9999:9999 quay.io/influxdb/influxdb:2.0.0-beta
docker run --name influxdb -p 8086:8086 quay.io/influxdb/influxdb:2.0.0-rc
```
_To run InfluxDB in [detached mode](https://docs.docker.com/engine/reference/run/#detached-vs-foreground), include the `-d` flag in the `docker run` command._
@ -434,7 +435,7 @@ To opt-out of sending telemetry data back to InfluxData, include the
`--reporting-disabled` flag when starting the InfluxDB container.
```bash
docker run -p 9999:9999 quay.io/influxdb/influxdb:2.0.0-beta --reporting-disabled
docker run -p 8086:8086 quay.io/influxdb/influxdb:2.0.0-rc --reporting-disabled
```
{{% /note %}}
@ -454,9 +455,8 @@ docker exec -it influxdb /bin/bash
### Install InfluxDB in a Kubernetes cluster
{{% note %}}
The instructions below use Minikube, but the steps should be similar in any Kubernetes cluster.
{{% /note %}}
InfluxData also makes [Helm charts](https://github.com/influxdata/helm-charts) available.
1. [Install Minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/).
@ -495,10 +495,10 @@ The instructions below use Minikube, but the steps should be similar in any Kube
You should see an IP address after `Endpoints` in the command's output.
6. Forward port 9999 from inside the cluster to localhost:
6. Forward port 8086 from inside the cluster to localhost:
```sh
kubectl port-forward -n influxdb service/influxdb 9999:9999
kubectl port-forward -n influxdb service/influxdb 8086:8086
```
{{% /tab-content %}}
@ -523,7 +523,7 @@ the `influx` command line interface (CLI).
{{% tab-content %}}
### Set up InfluxDB through the UI
1. With InfluxDB running, visit [localhost:9999](http://localhost:9999).
1. With InfluxDB running, visit [localhost:8086](http://localhost:8086).
2. Click **Get Started**
#### Set up your initial user
@ -546,7 +546,7 @@ If you set up InfluxDB through the UI and want to use the [`influx` CLI](/influx
```sh
# Set up a configuration profile
influx config create -n default \
-u http://localhost:9999 \
-u http://localhost:8086 \
-o example-org \
-t mySuP3rS3cr3tT0keN \
-a

30
content/influxdb/v2.0/influxdb-templates/_index.md
View File

@ -1,29 +1,31 @@
---
title: InfluxDB templates
description: >
InfluxDB templates are prepackaged InfluxDB configurations that contain everything
InfluxDB templates are preconfigured InfluxDB resources and can contain everything
from dashboards and Telegraf configurations to notifications and alerts.
menu: influxdb_2_0
weight: 9
influxdb/v2.0/tags: [templates]
---
InfluxDB templates are prepackaged InfluxDB configurations that contain everything
InfluxDB templates are preconfigured InfluxDB resources and can contain everything
from dashboards and Telegraf configurations to notifications and alerts.
Use InfluxDB templates to quickly set up a fresh instance of InfluxDB, back up your
dashboard configuration, or share your configuration with the InfluxData community.
Use InfluxDB templates to quickly get set up monitoring a specific technology,
set up a fresh instance of InfluxDB, back up your dashboard configuration, or
share your configuration with the InfluxData community.
**InfluxDB templates do the following:**
- Reduce setup time
- Facilitate secure, portable, source-controlled InfluxDB platform states.
- Reduce setup time by giving you resources that are already configured for your use-case.
- Facilitate secure, portable, and source-controlled InfluxDB resource states.
- Simplify sharing and using pre-built InfluxDB solutions.
{{< youtube 2JjW4Rym9XE >}}
## Template manifests
A template consists of a single file known as a **manifest** that defines the
InfluxDB state and associated [resources](#template-resources).
A template consists of one or more files known as **manifests** that define the
InfluxDB [resources](#template-resources).
Template manifests support the following formats:
- [YAML](https://yaml.org/)
@ -38,12 +40,13 @@ Template manifests are compatible with
The `metadata.name` field in manifests uniquely identifies each resource in the template.
`metadata.name` values must be [DNS-1123](https://tools.ietf.org/html/rfc1123) compliant.
If resources in the template depend on other InfluxDB resources, all dependencies
must be included in the template.
should be included in the template, otherwise, the resources may not be usable.
_See [Create an InfluxDB template](/influxdb/v2.0/influxdb-templates/create/) for information about
generating template manifests._
### Template resources
Include the following **resources** in a template:
- buckets
@ -57,11 +60,12 @@ Include the following **resources** in a template:
- Telegraf configurations
## Stacks
**InfluxDB stacks** are stateful InfluxDB templates.
When you apply a template, InfluxDB associates resources in the template with a stack.
Use stacks to add, update, or remove templated resources over time.
For more information, see [InfluxDB Stacks](#influxdb-stacks) below.
Use **InfluxDB stacks** to manage InfluxDB templates.
When you apply a template, InfluxDB associates resources in the template with a stack.
Use stacks to add, update, or remove InfluxDB templates over time.
For more information, see [InfluxDB stacks](#influxdb-stacks) below.
---

46
content/influxdb/v2.0/influxdb-templates/cloud.md
View File

@ -2,8 +2,7 @@
title: InfluxDB templates in InfluxDB Cloud
list_title: InfluxDB templates in Cloud
description: >
Download and use the `influx` CLI to apply and manage InfluxDB templates with
your InfluxDB Cloud account.
Install templates directly in the UI or download the `influx` CLI to apply and manage InfluxDB templates in your InfluxDB Cloud account.
menu:
influxdb_2_0:
parent: InfluxDB templates
@ -15,9 +14,48 @@ influxdb/v2.0/tags: [templates]
products: [cloud]
---
Use the [`influx` command line interface (CLI)](/influxdb/v2.0/reference/cli/influx/)
to apply and manage templates in your InfluxDB Cloud account.
To use templates in InfluxDB Cloud, you have a couple options:
- [Install and customize templates directly in the Cloud UI](#install-and-customize-a-template-in-the-cloud-ui)
- [Apply and manage templates using the `influx` CLI](#apply-and-manage-templates-using-the-influx-cli)
## Install and customize a template in the Cloud UI
{{% note %}}
To ensure the template works, complete the **ReadMe** instructions after installing a template. For example, you may need to configure telegraf to write specific data to your Cloud instance before the template can be used.
{{% /note %}}
1. Under **Settings** icon in the navigation bar.
{{< nav-icon "settings" >}}
2. Click **Templates**.
3. (Optional) If you already have a template URL, you can skip this step. Click **Browse Community Templates** to explore templates and obtain a template URL (YAML or JSON file).
4. Enter the URL to the template's YAML or JSON file (from the [InfluxData Community Templates](https://github.com/influxdata/community-templates) repository), and then click **Lookup Template**.
The Template Installer displays the template name and the number of resources included in the template (for example, dashboards, Telegraf configurations, buckets, and more).
5. Click **Install Template**. A message confirms the template has been successfully installed.
6. Under **Installed Templates**, find the template, and do the following:
- Click **View Readme**. Complete the instructions to finalize your template.
- (Optional) To customize a template, under **Installed Resources**, expand the template resources, and then click a resource to update it. Update any of the following resources included in the template:
- Buckets. [Update buckets](/influxdb/v2.0/organizations/buckets/update-bucket/)
- Dashboards. [Control dashboards](/influxdb/v2.0/visualize-data/dashboards/control-dashboard/)
- Labels. [Edit labels](/influxdb/v2.0/visualize-data/labels/#edit-a-label)
- Checks. [Update checks](/influxdb/v2.0/monitor-alert/checks/update/)
- Notification endpoints. [Update notification endpoints](/influxdb/v2.0/monitor-alert/notification-endpoints/update/)
- Notification rules. [Update notification rules](/influxdb/v2.0/monitor-alert/notification-rules/update/)
- Telegraf configurations. [Update a Telegraf configurations](/influxdb/v2.0/telegraf-configs/update/)
7. (Optional) Add or delete resources from the template, and then use the `influx` CLI to [export resources to a new template (JSON or YAML file)](/influxdb/v2.0/influxdb-templates/create/#export-all-resources).
{{% note %}}
To install and configure the `influx` CLI, complete steps 1-2 in the procedure below.
{{% /note %}}
## Apply and manage templates using the influx CLI
Use the [`influx` CLI](/influxdb/v2.0/reference/cli/influx/)
to apply and manage templates in your InfluxDB Cloud account.
If you haven’t already, do the following:
1. [Download and install `influx` CLI](/influxdb/v2.0/get-started/#optional-download-install-and-use-the-influx-cli).

32
content/influxdb/v2.0/influxdb-templates/create.md
View File

@ -51,6 +51,7 @@ In **InfluxDB Cloud**, your user account is an organization.
4. Export the template _(see [below](#export-a-template))_.
## Export a template
Do one of the following to export a template:
- [Export all resources in an organization](#export-all-resources)
@ -58,6 +59,7 @@ Do one of the following to export a template:
- [Export a stack and its associated resources](#export-a-stack)
### Export all resources
To export all templatable resources within an organization to a template manifest,
use the `influx export all` command.
Provide the following:
@ -69,6 +71,7 @@ Provide the following:
**JSON** (`.json`) are supported.
###### Export all resources to a template
```sh
# Syntax
influx export all -o <org-name> -f <file-path> -t <token>
@ -81,11 +84,13 @@ influx export all \
```
#### Export resources filtered by labelName or resourceKind
The `influx export all` command has an optional `--filter` flag that exports
only resources that match specified label names or resource kinds.
Provide multiple filters for both `labelName` and `resourceKind`
Provide multiple filters for both `labelName` and `resourceKind`.
###### Export only dashboards and buckets with specific labels
The following example exports resources that match this predicate logic:
```js
@ -109,8 +114,8 @@ For information about flags, see the
[`influx export all` documentation](/influxdb/v2.0/reference/cli/influx/export/all/).
### Export specific resources
To export specific resources within an organization to a template manifest,
use the `influx export` with resource flags for each resource to include.
To export specific resources within an organization to a template manifest, use the `influx export` with resource flags for each resource to include.
Provide the following:
- **Organization name** or **ID**
@ -118,16 +123,17 @@ Provide the following:
- **Destination path and filename** for the template manifest.
The filename extension determines the template format—both **YAML** (`.yml`) and
**JSON** (`.json`) are supported.
- **Resource flags** with corresponding lists of resource IDs to include in the template.
- **Resource flags** with corresponding lists of resource IDs or resource names to include in the template.
For information about what resource flags are available, see the
[`influx export` documentation](/influxdb/v2.0/reference/cli/influx/export/).
###### Export specific resources to a template
```sh
# Syntax
influx export all -o <org-name> -f <file-path> -t <token> [resource-flags]
# Example
# Export specific resources by ID
influx export all \
-o my-org \
-f ~/templates/awesome-template.yml \
@ -135,9 +141,19 @@ influx export all \
--buckets=00x000ooo0xx0xx,o0xx0xx00x000oo \
--dashboards=00000xX0x0X00x000 \
--telegraf-configs=00000x0x000X0x0X0
# Export specific resources by name
influx export all \
-o my-org \
-f ~/templates/awesome-template.yml \
-t $INFLUX_TOKEN \
--bucket-names=bucket1,bucket2 \
--dashboard-names=dashboard1,dashboard2 \
--telegraf-config-names=telegrafconfig1,telegrafconfig2
```
### Export a stack
To export a stack and all its associated resources as a template, use the
`influx export stack` command.
Provide the following:
@ -150,6 +166,7 @@ Provide the following:
- **Stack ID**
###### Export a stack as a template
```sh
# Syntax
influx export stack \
@ -167,6 +184,7 @@ influx export stack \
```
## Include user-definable resource names
After exporting a template manifest, replace resource names with **environment references**
to let users customize resource names when installing your template.
@ -178,7 +196,7 @@ to let users customize resource names when installing your template.
- `endpointName` _(unique to `NotificationRule` resources)_
3. Replace the resource field value with an `envRef` object with a `key` property
that reference the key of a key-value pair the user provides when installing the template.
that references the key of a key-value pair the user provides when installing the template.
During installation, the `envRef` object is replaced by the value of the
referenced key-value pair.
If the user does not provide the environment reference key-value pair, InfluxDB
@ -233,6 +251,7 @@ exist in the template and what keys to use to replace them._
{{% note %}}
#### Resource fields that support environment references
Only the following fields support environment references:
- `metadata.name`
@ -241,6 +260,7 @@ Only the following fields support environment references:
{{% /note %}}
## Share your InfluxDB templates
Share your InfluxDB templates with the entire InfluxData community.
**Contribute your template to the [InfluxDB Community Templates](https://github.com/influxdata/community-templates/)
repository on GitHub.**

49
content/influxdb/v2.0/influxdb-templates/stacks/_index.md
View File

@ -1,51 +1,26 @@
---
title: InfluxDB stacks
description: >
InfluxDB stacks are stateful InfluxDB templates that let you add,
update, and remove templated resources over time, avoid duplicating resources
when applying the same or similar templates more than once, and apply
changes to distributed instances of InfluxDB OSS or InfluxDB Cloud.
Use an InfluxDB stack to manage your InfluxDB templates—add, update, or remove templates over time.
menu:
influxdb_2_0:
parent: InfluxDB templates
weight: 105
related:
- /influxdb/v2.0/reference/cli/stacks/
- /v2.0/reference/cli/influx/pkg/stack/
---
**InfluxDB stacks** are **stateful [InfluxDB templates](/influxdb/v2.0/influxdb-templates)**
that let you add, update, and remove templated resources over time, avoid
duplicating resources when applying the same or similar templates more than once,
and apply changes to distributed instances of InfluxDB OSS or InfluxDB Cloud.
Use InfluxDB stacks to manage [InfluxDB templates](/influxdb/v2.0/influxdb-templates).
When you apply a template, InfluxDB associates resources in the template with a stack. Use the stack to add, update, or remove InfluxDB templates over time.
## Ideal use cases for InfluxDB stacks
Stacks help save time and effort in the following use cases:
{{< children type="anchored-list" >}}
- [Actively develop and extend templates](#actively-develop-and-extend-templates)
- [Apply updates from source-controlled templates](#apply-updates-from-source-controlled-templates)
- [Apply template updates across multiple InfluxDB instances](#apply-template-updates-across-multiple-influxdb-instances)
{{< children readmore=true >}}
### Actively develop and extend templates
InfluxDB stacks aid in developing and maintaining InfluxDB templates.
Stacks let you modify and update template manifests and apply those changes in
any stack that uses the template.
{{% note %}}
**Key differences between stacks and templates**:
### Apply updates from source-controlled templates
You can use a variety of InfluxDB templates from many different sources including
[Community Templates](https://github.com/influxdata/community-templates/) or
self-built custom templates.
As templates are updated over time, stacks allow template users to gracefully
apply updates without creating duplicate resources.
### Apply template updates across multiple InfluxDB instances
In many cases, users have more than one instance of InfluxDB running and apply
the same template to each separate instance.
By using stacks, you can make changes to a stack on one instance,
[export the stack as a template](/influxdb/v2.0/influxdb-templates/create/#export-a-stack)
and then apply the changes to your other InfluxDB instances.
## Manage InfluxDB Stacks
{{< children type="anchored-list" >}}
{{< children readmore=true >}}
- A template defines a set of resources in a text file outside of InfluxDB. When you apply a template, a stack is automatically created to manage the applied template.
- Stacks add, modify or delete resources in an instance.
- Templates do not recognize resources in an instance. All resources in the template are added, creating duplicate resources if a resource already exists.
{{% /note %}}

2
content/influxdb/v2.0/influxdb-templates/stacks/init.md
View File

@ -9,7 +9,7 @@ menu:
influxdb_2_0:
parent: InfluxDB stacks
name: Initialize a stack
weight: 201
weight: 202
related:
- /influxdb/v2.0/reference/cli/influx/stacks/init/
list_code_example: |

2
content/influxdb/v2.0/influxdb-templates/stacks/remove.md
View File

@ -8,7 +8,7 @@ menu:
influxdb_2_0:
parent: InfluxDB stacks
name: Remove a stack
weight: 204
weight: 205
related:
- /influxdb/v2.0/reference/cli/influx/stacks/remove/
list_code_example: |

165
content/influxdb/v2.0/influxdb-templates/stacks/save-time.md Normal file
View File

@ -0,0 +1,165 @@
---
title: Save time with InfluxDB stacks
list_title: Save time with stacks
description: >
Discover how to use InfluxDB stacks to save time.
menu:
influxdb_2_0:
parent: InfluxDB stacks
name: Save time with stacks
weight: 201
related:
- /influxdb/v2.0/reference/cli/influx/stacks/
---
Save time and money using InfluxDB stacks. Here's a few ideal use cases:
- [Automate deployments with GitOps and stacks](#automate-deployments-with-gitops-and-stacks)
- [Apply updates from source-controlled templates](#apply-updates-from-source-controlled-templates)
- [Apply template updates across multiple InfluxDB instances](#apply-template-updates-across-multiple-influxdb-instances)
- [Develop templates](#develop-templates)
### Automate deployments with GitOps and stacks
GitOps is popular way to configure and automate deployments. Use InfluxDB stacks in a GitOps workflow
to automatically update distributed instances of InfluxDB OSS or InfluxDB Cloud.
To automate an InfluxDB deployment with GitOps and stacks, complete the following steps:
1. [Set up a GitHub repository](#set-up-a-github-repository)
2. [Add existing resources to the GitHub repository](#add-existing-resources-to-the-github-repository)
3. [Automate the creation of a stack for each folder](#automate-the-creation-of-a-stack-for-each-folder)
4. [Set up Github Actions or CircleCI](#set-up-github-actions-or-circleci)
#### Set up a GitHub repository
Set up a GitHub repository to back your InfluxDB instance. Determine how you want to organize the resources in your stacks within your Github repository. For example, organize resources under folders for specific teams or functions.
We recommend storing all resources for one stack in the same folder. For example, if you monitor Redis, create a `redis` stack and put your Redis monitoring resources (a Telegraf configuration, four dashboards, a label, and two alert checks) into one Redis folder, each resource in a separate file. Then, when you need to update a Redis resource, it's easy to find and make changes in one location.
{{% note %}}
Typically, we **do not recommend** using the same resource in multiple stacks. If your organization uses the same resource in multiple stacks, before you delete a stack, verify the stack does not include resources that another stack depends on. Stacks with buckets often contain data used by many different templates. Because of this, we recommend keeping buckets separate from the other stacks.
{{% /note %}}
#### Add existing resources to the GitHub repository
Skip this section if you are starting from scratch or don’t have existing resources you want to add to your stack.
Use the `influx export` command to quickly export resources. Keep all your resources in a single file or have files for each one. You can always split or combine them later.
For example, if you export resources for three stacks: `buckets`, `redis`, and `mysql`, your folder structure might look something like this when you are done:
```sh
influxdb-assets/
├── buckets/
│ ├── telegraf_bucket.yml
├── redis/
│ ├── redis_overview_dashboard.yml
│ ├── redis_label.yml
│ ├── redis_cpu_check.yml
│ └── redis_mem_check.yml
├── mysql/
│ ├── mysql_assets.yml
└── README.md
```
{{% note %}}
When you export a resource, InfluxDB creates a `meta.name` for that resource. These resource names should be unique inside your InfluxDB instance. Use a good naming convention to prevent duplicate `meta.names`. Changing the `meta.name` of the InfluxDB resource will cause the stack to orphan the resource with the previous name and create a new resource with the updated name.
{{% /note %}}
Add the exported resources to your new GitHub repository.
#### Automate the creation of a stack for each folder
To automatically create a stack from each folder in your GitHub repository, create a shell script to check for an existing stack and if the stack isn't found, use the `influx stacks init` command to create a new stack. The following sample script creates a `redis` stack and automatically applies those changes to your instance:
```sh
echo "Checking for existing redis stack..."
REDIS_STACK_ID=$(influx stacks --stack-name redis --json | jq -r '.[0].ID')
if [ "$REDIS_STACK_ID" == "null" ]; then
echo "No stack found. Initializing our stack..."
REDIS_STACK_ID=$(influx stacks init -n redis --json | jq -r '.ID')
fi
# Setting the base path
BASE_PATH="$(pwd)"
echo "Applying our redis stack..."
cat $BASE_PATH/redis/*.yml | \
influx apply --force true --stack-id $REDIS_STACK_ID -q
```
{{% note %}}
The `--json` flag in the InfluxDB CLI is very useful when scripting against the CLI. This flag lets you grab important information easily using [`jq`](https://stedolan.github.io/jq/manual/v1.6/).
{{% /note %}}
Repeat this step for each of the stacks in your repository. When a resource in your stack changes, re-run this script to apply updated resources to your InfluxDB instance. Re-applying a stack with an updated resource won't add, delete, or duplicate resources.
#### Set up Github Actions or CircleCI
Once you have a script to apply changes being made to your local instance, automate the deployment to other environments as needed. Use the InfluxDB CLI to maintain multiple [configuration profiles]() to easily switch profile and issue commands against other InfluxDB instances. To apply the same script to a different InfluxDB instance, change your active configuration profile using the `influx config set` command. Or set the desired profile dynamically using the `-c, --active-config` flag.
{{% note %}}
Before you run automation scripts against shared environments, we recommend manually running the steps in your script.
{{% /note %}}
Verify your deployment automation software lets you run a custom script, and then set up the custom script you've built locally another environment. For example, here's a custom Github Action that automates deployment:
```yml
name: deploy-influxdb-resources
on:
push:
branches: [ master ]
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
ref: ${{ github.ref }}
- name: Deploys repo to cloud
env:
# These secrets can be configured in the Github repo to connect to
# your InfluxDB instance.
INFLUX_TOKEN: ${{ secrets.INFLUX_TOKEN }}
INFLUX_ORG: ${{ secrets.INFLUX_ORG }}
INFLUX_URL: ${{ secrets.INFLUX_URL }}
GITHUB_REPO: ${{ github.repository }}
GITHUB_BRANCH: ${{ github.ref }}
run: |
cd /tmp
wget https://dl.influxdata.com/platform/nightlies/influx_nightly_linux_amd64.tar.gz
tar xvfz influx_nightly_linux_amd64.tar.gz
sudo cp influx_nightly_linux_amd64/influx /usr/local/bin/
cd $GITHUB_WORKSPACE
# This runs the script to set up your stacks
chmod +x ./setup.sh
./setup.sh prod
```
For more information about using GitHub Actions in your project, check out the complete [Github Actions documentation](https://github.com/features/actions).
### Apply updates from source-controlled templates
You can use a variety of InfluxDB templates from many different sources including
[Community Templates](https://github.com/influxdata/community-templates/) or
self-built custom templates.
As templates are updated over time, stacks let you gracefully
apply updates without creating duplicate resources.
### Apply template updates across multiple InfluxDB instances
In many cases, you may have more than one instance of InfluxDB running and want to apply
the same template to each separate instance.
Using stacks, you can make changes to a stack on one instance,
[export the stack as a template](/influxdb/v2.0/influxdb-templates/create/#export-a-stack)
and then apply the changes to your other InfluxDB instances.
### Develop templates
InfluxDB stacks aid in developing and maintaining InfluxDB templates.
Stacks let you modify and update template manifests and apply those changes in
any stack that uses the template.

2
content/influxdb/v2.0/influxdb-templates/stacks/update.md
View File

@ -12,7 +12,7 @@ menu:
influxdb_2_0:
parent: InfluxDB stacks
name: Update a stack
weight: 202
weight: 203
related:
- /influxdb/v2.0/reference/cli/influx/apply
- /influxdb/v2.0/reference/cli/influx/stacks/update/

5
content/influxdb/v2.0/influxdb-templates/stacks/view.md
View File

@ -8,7 +8,7 @@ menu:
influxdb_2_0:
parent: InfluxDB stacks
name: View stacks
weight: 203
weight: 204
related:
- /influxdb/v2.0/reference/cli/influx/stacks/
list_code_example: |
@ -34,10 +34,12 @@ influx stacks -o example-org
```
### Filter stacks
To output information about specific stacks, use the `--stack-name` or `--stack-id`
flags to filter output by stack names or stack IDs.
##### Filter by stack name
```sh
# Syntax
influx stacks \
@ -52,6 +54,7 @@ influx stacks \
```
### Filter by stack ID
```sh
# Syntax
influx stacks \

2
content/influxdb/v2.0/monitor-alert/notification-endpoints/_index.md
View File

@ -15,6 +15,6 @@ related:
Notification endpoints store information to connect to a third party service.
If you're using the Free Plan, create a Slack endpoint.
If you're using the Usage-based Plan, create a connection to a HTTP, Slack, or PagerDuty endpoint.
If you're using the Usage-based Plan, create a connection to a HTTP, Slack, Telegram, or PagerDuty endpoint.
{{< children >}}

4
content/influxdb/v2.0/monitor-alert/notification-endpoints/create.md
View File

@ -31,6 +31,7 @@ To send notifications about changes in your data, start by creating a notificati
| **Slack** | **{{< icon "check" >}}** | **{{< icon "check" >}}** | **{{< icon "check" >}}** |
| **PagerDuty** | **{{< icon "check" >}}** | | **{{< icon "check" >}}** |
| **HTTP** | **{{< icon "check" >}}** | | **{{< icon "check" >}}** |
| **Telegram** | **{{< icon "check" >}}** | **{{< icon "check" >}}** | **{{< icon "check" >}}** |
5. In the **Name** and **Description** fields, enter a name and description for the endpoint.
6. Enter enter information to connect to the endpoint:
@ -43,4 +44,7 @@ To send notifications about changes in your data, start by creating a notificati
- [Create a new service](https://support.pagerduty.com/docs/services-and-integrations#section-create-a-new-service), [add an integration for your service](https://support.pagerduty.com/docs/services-and-integrations#section-add-integrations-to-an-existing-service), and then enter the PagerDuty integration key for your new service in the **Routing Key** field.
- The **Client URL** provides a useful link in your PagerDuty notification. Enter any URL that you'd like to use to investigate issues. This URL is sent as the `client_url` property in the PagerDuty trigger event. By default, the **Client URL** is set to your Monitoring & Alerting History page, and the following included in the PagerDuty trigger event: `"client_url": "https://us-west-2-1.aws.cloud2.influxdata.net/orgs/<your-org-ID>/alert-history”`
- For Telegram:
- Enter a Telegram **Bot Token** and **Chat ID**. For details, see [Set up a Telegram bot](/influxdb/v2.0/reference/flux/stdlib/contrib/telegram/#set-up-a-telegram-bot).
6. Click **Create Notification Endpoint**.

2
content/influxdb/v2.0/monitor-alert/templates/infrastructure/aws.md
View File

@ -35,7 +35,7 @@ The AWS CloudWatch Monitoring template includes the following:
```sh
## k8s
[[outputs.influxdb_v2]]
urls = ["http://influxdb.monitoring:9999"]
urls = ["http://influxdb.monitoring:8086"]
organization = "InfluxData"
bucket = "kubernetes"
token = "secret-token"

2
content/influxdb/v2.0/organizations/view-orgs.md
View File

@ -45,7 +45,7 @@ After logging in to the InfluxDB UI, your organization ID appears in the URL.
<pre class="highlight">
http://localhost:9999/orgs/<span class="bp" style="font-weight:bold;margin:0 .15rem">03a2bbf46249a000</span>/...
http://localhost:8086/orgs/<span class="bp" style="font-weight:bold;margin:0 .15rem">03a2bbf46249a000</span>/...
</pre>

14
content/influxdb/v2.0/process-data/get-started.md
View File

@ -21,6 +21,7 @@ This article walks through writing a basic InfluxDB task that downsamples
data and stores it in a new bucket.
## Components of a task
Every InfluxDB task needs the following four components.
Their form and order can vary, but they are all essential parts of a task.
@ -32,6 +33,7 @@ Their form and order can vary, but they are all essential parts of a task.
_[Skip to the full example task script](#full-example-task-script)_
## Define task options
Task options define specific information about the task.
The example below illustrates how task options are defined in your Flux script:
@ -53,6 +55,7 @@ When creating a task in the InfluxDB user interface (UI), task options are defin
{{% /note %}}
## Define a data source
Define a data source using Flux's [`from()` function](/influxdb/v2.0/reference/flux/stdlib/built-in/inputs/from/)
or any other [Flux input functions](/influxdb/v2.0/reference/flux/stdlib/built-in/inputs/).
@ -70,6 +73,7 @@ data = from(bucket: "telegraf/default")
{{% note %}}
#### Using task options in your Flux script
Task options are passed as part of a `task` option record and can be referenced in your Flux script.
In the example above, the time range is defined as `-task.every`.
@ -80,10 +84,18 @@ Using task options to define values in your Flux script can make reusing your ta
{{% /note %}}
## Process or transform your data
The purpose of tasks is to process or transform data in some way.
What exactly happens and what form the output data takes is up to you and your
specific use case.
{{% note %}}
#### Account for latent data with an offset
To account for latent data (like data streaming from your edge devices), use an offset in your task. For example, if you set a task interval on the hour with the options `every: 1h` and `offset: 5m`, a task executes 5 minutes after the task interval but the query [`now()`](/influxdb/v2.0/reference/flux/stdlib/built-in/misc/now/) time is on the exact hour.
{{% /note %}}
The example below illustrates a task that downsamples data by calculating the average of set intervals.
It uses the `data` variable defined [above](#define-a-data-source) as the data source.
It then windows the data into 5 minute intervals and calculates the average of each
@ -100,6 +112,7 @@ data
_See [Common tasks](/influxdb/v2.0/process-data/common-tasks) for examples of tasks commonly used with InfluxDB._
## Define a destination
In the vast majority of task use cases, once data is transformed, it needs to be sent and stored somewhere.
This could be a separate bucket or another measurement.
@ -116,6 +129,7 @@ In order to write data into InfluxDB, you must have `_time`, `_measurement`, `_f
{{% /note %}}
## Full example task script
Below is a task script that combines all of the components described above:
```js

4
content/influxdb/v2.0/process-data/task-options.md
View File

@ -40,6 +40,7 @@ options task = {
```
## every
The interval at which the task runs.
_**Data type:** Duration_
@ -70,6 +71,7 @@ options task = {
```
## offset
Delays the execution of the task but preserves the original time range.
For example, if a task is to run on the hour, a `10m` offset will delay it to 10
minutes after the hour, but all time ranges defined in the task are relative to
@ -81,7 +83,7 @@ _**Data type:** Duration_
```js
options task = {
// ...
offset: "0 * * * *",
offset: 10m,
}
```

4
content/influxdb/v2.0/query-data/execute-queries.md
View File

@ -80,7 +80,7 @@ Below is an example `curl` command that queries InfluxDB:
{{% code-tab-content %}}
```bash
curl http://localhost:9999/api/v2/query?org=my-org -XPOST -sS \
curl http://localhost:8086/api/v2/query?org=my-org -XPOST -sS \
-H 'Authorization: Token YOURAUTHTOKEN' \
-H 'Accept: application/csv' \
-H 'Content-type: application/vnd.flux' \
@ -93,7 +93,7 @@ curl http://localhost:9999/api/v2/query?org=my-org -XPOST -sS \
{{% code-tab-content %}}
```bash
curl http://localhost:9999/api/v2/query?org=my-org -XPOST -sS \
curl http://localhost:8086/api/v2/query?org=my-org -XPOST -sS \
-H 'Authorization: Token YOURAUTHTOKEN' \
-H 'Accept: application/csv' \
-H 'Content-type: application/vnd.flux' \

2
content/influxdb/v2.0/query-data/flux/sql.md
View File

@ -233,7 +233,7 @@ to store your database credentials as secrets.
{{% /tabs %}}
{{% tab-content %}}
```sh
curl -X PATCH http://localhost:9999/api/v2/orgs/<org-id>/secrets \
curl -X PATCH http://localhost:8086/api/v2/orgs/<org-id>/secrets \
-H 'Authorization: Token YOURAUTHTOKEN' \
-H 'Content-type: application/json' \
-d '{

9
content/influxdb/v2.0/query-data/influxql.md
View File

@ -9,7 +9,6 @@ menu:
influxdb_2_0:
name: Query with InfluxQL
parent: Query data
products: [cloud]
related:
- /influxdb/v2.0/reference/api/influxdb-1x/
- /influxdb/v2.0/reference/api/influxdb-1x/query
@ -114,12 +113,16 @@ To learn more about InfluxQL, see [Influx Query Language (InfluxQL)](/influxdb/v
##### Supported InfluxQL queries
- `DELETE`*
- `DROP MEASUREMENT`*
- `SELECT` _(read-only)_
- `SHOW DATABASES`
- `SHOW MEASUREMENTS`
- `SHOW TAG KEYS`
- `SHOW TAG VALUES`
- `SHOW FIELD KEYS`
\* These commands delete data.
{{% /note %}}
{{< /flex-content >}}
{{< flex-content >}}
@ -130,8 +133,8 @@ To learn more about InfluxQL, see [Influx Query Language (InfluxQL)](/influxdb/v
- `SELECT INTO`
- `ALTER`
- `CREATE`
- `DELETE`
- `DROP`
<!-- - `DELETE` -->
- `DROP` (see above)
- `GRANT`
- `KILL`
- `REVOKE`

4
content/influxdb/v2.0/reference/api/_index.md
View File

@ -17,7 +17,7 @@ Include your authentication token as an `Authorization` header in each request.
```sh
curl --request POST \
--url http://localhost:9999/api/v2/write?org=my-org&bucket=example-bucket \
--url http://localhost:8086/api/v2/write?org=my-org&bucket=example-bucket \
--header 'Authorization: Token YOURAUTHTOKEN'
```
@ -28,7 +28,7 @@ curl --request POST \
InfluxDB API documentation is built into the `influxd` service and represents
the API specific to the current version of InfluxDB.
To view the API documentation locally, [start InfluxDB](/influxdb/v2.0/get-started/#start-influxdb)
and visit the `/docs` endpoint in a browser ([localhost:9999/docs](http://localhost:9999/docs)).
and visit the `/docs` endpoint in a browser ([localhost:8086/docs](http://localhost:8086/docs)).
## InfluxDB client libraries
InfluxDB client libraries are language-specific packages that integrate with the InfluxDB v2 API.

10
content/influxdb/v2.0/reference/api/influxdb-1x/_index.md
View File

@ -8,7 +8,6 @@ menu:
parent: InfluxDB v2 API
weight: 104
influxdb/v2.0/tags: [influxql, query, write]
products: [cloud]
related:
- /influxdb/v2.0/query-data/influxql
---
@ -57,6 +56,15 @@ Authorization: Token <token>
Authorization: Token mYSuP3rs3cREtT0k3N
```
##### InfluxQL support
The compatibility API supports InfluxQL, with the following caveats:
- The `INTO` clause (e.g. `SELECT ... INTO ...`) is not supported.
- With the exception of [`DELETE`](/influxdb/v1.8/query_language/manage-database/#delete-series-with-delete) and
[`DROP MEASUREMENT`](/influxdb/v1.8/query_language/manage-database/#delete-measurements-with-drop-measurement) queries, which are still allowed,
InfluxQL database management commands are not supported.
## Compatibility endpoints
{{< children readmore=true >}}

1
content/influxdb/v2.0/reference/api/influxdb-1x/dbrp.md
View File

@ -8,7 +8,6 @@ menu:
name: DBRP mapping
parent: 1.x compatibility
weight: 302
products: [cloud]
related:
- /influxdb/v2.0/reference/api/influxdb-1x/query
- /influxdb/v2.0/reference/api/influxdb-1x/write

1
content/influxdb/v2.0/reference/api/influxdb-1x/query.md
View File

@ -9,7 +9,6 @@ menu:
parent: 1.x compatibility
weight: 301
influxdb/v2.0/tags: [influxql, query]
products: [cloud]
list_code_example: |
<pre>
<span class="api get">GET</span> https://cloud2.influxdata.com/query

5
content/influxdb/v2.0/reference/api/influxdb-1x/write.md
View File

@ -2,7 +2,7 @@
title: /write 1.x compatibility API
list_title: /write
description: >
The `/write` 1.x compatibilty endpoint writes data to InfluxDB 2.0 using patterns from the
The `/write` 1.x compatibility endpoint writes data to InfluxDB 2.0 using patterns from the
InfluxDB 1.x `/write` API endpoint.
menu:
influxdb_2_0_ref:
@ -10,7 +10,6 @@ menu:
parent: 1.x compatibility
weight: 301
influxdb/v2.0/tags: [write]
products: [cloud]
list_code_example: |
<pre>
<span class="api post">POST</span> https://cloud2.influxdata.com/write
@ -19,7 +18,7 @@ related:
- /influxdb/v2.0/reference/syntax/line-protocol
---
The `/write` 1.x compatibilty endpoint writes data to InfluxDB 2.0 using patterns from the
The `/write` 1.x compatibility endpoint writes data to InfluxDB 2.0 using patterns from the
InfluxDB 1.x `/write` API endpoint.
Use the `POST` request method to write [line protocol](/influxdb/v2.0/reference/syntax/line-protocol/)
to the `/write` endpoint.

3
content/influxdb/v2.0/reference/cli/influx/_index.md
View File

@ -32,7 +32,7 @@ influx [command]
```sh
# Set up a configuration profile
influx config create -n default \
-u http://localhost:9999 \
-u http://localhost:8086 \
-o example-org \
-t mySuP3rS3cr3tT0keN \
-a
@ -67,6 +67,7 @@ influx [command]
| [template](/influxdb/v2.0/reference/cli/influx/template) | Summarize and validate an InfluxDB template |
| [transpile](/influxdb/v2.0/reference/cli/influx/transpile) | Manually transpile an InfluxQL query to Flux |
| [user](/influxdb/v2.0/reference/cli/influx/user) | User management commands |
| [version](/influxdb/v2.0/reference/cli/influx/version) | Print the influx CLI version |
| [write](/influxdb/v2.0/reference/cli/influx/write) | Write points to InfluxDB |
## Mapped environment variables

5
content/influxdb/v2.0/reference/cli/influx/apply/_index.md
View File

@ -23,8 +23,9 @@ influx apply [flags]
## Flags
| Flag | | Description | Input Type | {{< cli/mapped >}} |
|:---- |:--- |:----------------------------- |:---------- |:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-c` | `--disable-color` | Disable color in output | | |
| | `--disable-color` | Disable color in output | | |
| | `--disable-table-borders` | Disable table borders | | |
| `-e` | `--encoding` | Encoding of the input stream | string | |
| | `--env-ref` | Environment references to provide with the template (format: `--env-ref=REF_KEY=REF_VALUE`) | string | |
@ -32,7 +33,7 @@ influx apply [flags]
| | `--filter` | Resources to skip when applying the template (filter by `kind` or `resource`) | string | |
| | `--force` | Ignore warnings about destructive changes | | |
| `-h` | `--help` | Help for the `apply` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | `INFLUX_HOST` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--json` | Output data as JSON | | `INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | Organization name that owns the bucket | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID that owns the bucket | string | `INFLUX_ORG_ID` |

21
content/influxdb/v2.0/reference/cli/influx/auth/active.md
View File

@ -16,13 +16,14 @@ influx auth active [flags]
```
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------:|:------------------ |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `active` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | `INFLUX_HOST` |
| `-i` | `--id` | **(Required)** Authorization ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------:|:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `active` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-i` | `--id` | **(Required)** Authorization ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |

3
content/influxdb/v2.0/reference/cli/influx/auth/create.md
View File

@ -18,10 +18,11 @@ influx auth create [flags]
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-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:9999`) | string | `INFLUX_HOST` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | **(Required)** Organization name | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID | string | `INFLUX_ORG_ID` |

21
content/influxdb/v2.0/reference/cli/influx/auth/delete.md
View File

@ -16,13 +16,14 @@ influx auth delete [flags]
```
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `delete` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | `INFLUX_HOST` |
| `-i` | `--id` | **(Required)** Authorization ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `delete` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-i` | `--id` | **(Required)** Authorization ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |

21
content/influxdb/v2.0/reference/cli/influx/auth/inactive.md
View File

@ -16,13 +16,14 @@ influx auth inactive [flags]
```
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `inactive` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | `INFLUX_HOST` |
| `-i` | `--id` | **(Required)** Authorization ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `inactive` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-i` | `--id` | **(Required)** Authorization ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |

29
content/influxdb/v2.0/reference/cli/influx/auth/list.md
View File

@ -21,17 +21,18 @@ influx auth list [flags]
`list`, `ls`, `find`
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `list` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | `INFLUX_HOST` |
| `-i` | `--id` | Authorization ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | Organization name | string | |
| | `--org-id` | Organization ID | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-u` | `--user` | Username | string | |
| | `--user-id` | User ID | string | |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `list` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-i` | `--id` | Authorization ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | Organization name | string | |
| | `--org-id` | Organization ID | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-u` | `--user` | Username | string | |
| | `--user-id` | User ID | string | |

17
content/influxdb/v2.0/reference/cli/influx/backup/_index.md
View File

@ -19,11 +19,12 @@ influx backup [flags]
```
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------:|:------------------ |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `backup` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | `INFLUX_HOST` |
| `-p` | `--path` | Directory path to write backup files to | string | `INFLUX_PATH` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------:|:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `backup` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-p` | `--path` | Directory path to write backup files to | string | `INFLUX_PATH` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |

15
content/influxdb/v2.0/reference/cli/influx/bucket/_index.md
View File

@ -26,10 +26,11 @@ influx bucket [command]
| [update](/influxdb/v2.0/reference/cli/influx/bucket/update) | Update bucket |
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:---------- |:------------------ |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `bucket` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | `INFLUX_HOST` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:---------- |:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `bucket` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |

29
content/influxdb/v2.0/reference/cli/influx/bucket/create.md
View File

@ -18,20 +18,21 @@ influx bucket create [flags]
```
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-d` | `--description` | Bucket description | string | |
| `-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:9999`) | string | `INFLUX_HOST` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | Bucket name | string | `INFLUX_BUCKET_NAME` |
| `-o` | `--org` | Organization name | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID | string | `INFLUX_ORG_ID` |
| `-r` | `--retention` | Duration bucket will retain data (0 is infinite, default is 0) | duration | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-d` | `--description` | Bucket description | string | |
| `-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` | Bucket name | string | `INFLUX_BUCKET_NAME` |
| `-o` | `--org` | Organization name | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID | string | `INFLUX_ORG_ID` |
| `-r` | `--retention` | Duration bucket will retain data (0 is infinite, default is 0) | duration | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
{{% note %}}
Valid `--retention` units are nanoseconds (`ns`), microseconds (`us` or `µs`),

27
content/influxdb/v2.0/reference/cli/influx/bucket/delete.md
View File

@ -20,16 +20,17 @@ influx bucket delete [flags]
```
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `delete` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | `INFLUX_HOST` |
| `-i` | `--id` | Bucket ID _(required if no `--name`)_ | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | Bucket name _(requires `--org` or `org-id`)_ | string | |
| `-o` | `--org` | Organization name | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `delete` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-i` | `--id` | Bucket ID _(required if no `--name`)_ | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | Bucket name _(requires `--org` or `org-id`)_ | string | |
| `-o` | `--org` | Organization name | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |

27
content/influxdb/v2.0/reference/cli/influx/bucket/list.md
View File

@ -22,16 +22,17 @@ influx bucket list [flags]
`list`, `ls`, `find`
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `list` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | `INFLUX_HOST` |
| `-i` | `--id` | Bucket ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | Bucket name | string | `INFLUX_BUCKET_NAME` |
| `-o` | `--org` | Organization name | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `list` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-i` | `--id` | Bucket ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | Bucket name | string | `INFLUX_BUCKET_NAME` |
| `-o` | `--org` | Organization name | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |

27
content/influxdb/v2.0/reference/cli/influx/bucket/update.md
View File

@ -18,19 +18,20 @@ influx bucket update [flags]
```
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-d` | `--description` | Bucket description | string | |
| `-h` | `--help` | Help for the `update` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | `INFLUX_HOST` |
| `-i` | `--id` | **(Required)** Bucket ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | New bucket name | string | `INFLUX_BUCKET_NAME` |
| `-r` | `--retention` | New duration bucket will retain data | duration | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-d` | `--description` | Bucket description | string | |
| `-h` | `--help` | Help for the `update` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-i` | `--id` | **(Required)** Bucket ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | New bucket name | string | `INFLUX_BUCKET_NAME` |
| `-r` | `--retention` | New duration bucket will retain data | duration | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
{{% note %}}
Valid `--retention` units are nanoseconds (`ns`), microseconds (`us` or `µs`),

4
content/influxdb/v2.0/reference/cli/influx/config/create.md
View File

@ -33,14 +33,14 @@ influx config create [flags]
# Create a connection configuration and set it active
influx config create --active \
-n config-name \
-u http://localhost:9999 \
-u http://localhost:8086 \
-t mySuP3rS3cr3tT0keN \
-o example-org
# Create a connection configuration without setting it active
influx config create \
-n config-name \
-u http://localhost:9999 \
-u http://localhost:8086 \
-t mySuP3rS3cr3tT0keN \
-o example-org
```

25
content/influxdb/v2.0/reference/cli/influx/dashboards/_index.md
View File

@ -18,18 +18,19 @@ influx dashboards [flags]
```
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `dashboards` command | | |
| | `--hide-headers` | Hide table headers | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | `$INFLUX_HOST` |
| `-i` | `--id` | Dashboard ID to retrieve | string | |
| | `--json` | Output data as JSON | | `INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | Organization name | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `dashboards` command | | |
| | `--hide-headers` | Hide table headers | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `$INFLUX_HOST` |
| `-i` | `--id` | Dashboard ID to retrieve | string | |
| | `--json` | Output data as JSON | | `INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | Organization name | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
## Examples
```sh

33
content/influxdb/v2.0/reference/cli/influx/delete/_index.md
View File

@ -11,30 +11,25 @@ influxdb/v2.0/tags: [delete]
The `influx delete` command deletes [points](/influxdb/v2.0/reference/glossary/#point)
from an InfluxDB bucket.
Identify points to delete using [delete predicate syntax](/influxdb/v2.0/reference/syntax/delete-predicate).
## Usage
```
influx delete [flags]
```
{{% warn %}}
Running `influx delete` without the `-p` or `--predicate` flag deletes all data with
timestamps between the specified `--start` and `--stop` times in the specified bucket.
{{% /warn %}}
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------:|:------------------ |
| `-b` | `--bucket` | Name of bucket to remove data from | string | `INFLUX_BUCKET_NAME` |
| | `--bucket-id` | Bucket ID | string | `INFLUX_BUCKET_ID` |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `delete` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | `INFLUX_HOST` |
| `-o` | `--org` | Organization name | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID | string | `INFLUX_ORG_ID` |
| `-p` | `--predicate` | InfluxQL-like predicate string (see [Delete predicate](/influxdb/v2.0/reference/syntax/delete-predicate)) | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--start` | Start time in RFC3339 format (i.e. `2009-01-02T23:00:00Z`) | string | |
| | `--stop` | Stop time in RFC3339 format (i.e. `2009-01-02T23:00:00Z`) | string | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------:|:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| `-b` | `--bucket` | Name of bucket to remove data from | string | `INFLUX_BUCKET_NAME` |
| | `--bucket-id` | Bucket ID | string | `INFLUX_BUCKET_ID` |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `delete` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-o` | `--org` | Organization name | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID | string | `INFLUX_ORG_ID` | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--start` | Start time in RFC3339 format (i.e. `2009-01-02T23:00:00Z`) | string | |
| | `--stop` | Stop time in RFC3339 format (i.e. `2009-01-02T23:00:00Z`) | string | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |

57
content/influxdb/v2.0/reference/cli/influx/export/_index.md
View File

@ -16,12 +16,14 @@ _For detailed examples of exporting InfluxDB templates, see
[Create an InfluxDB template](/influxdb/v2.0/influxdb-templates/create/)._
## Usage
```
influx export [flags]
influx export [command]
```
## Available subcommands
| Subcommand | Description |
|:---------- |:----------- |
| [all](/influxdb/v2.0/reference/cli/influx/export/all/) | Export all resources in an organization as a template |
@ -29,25 +31,34 @@ influx export [command]
## Flags
| Flag | | Description | Input Type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:---------- |:------------------ |
| | `--buckets` | Comma-separated list of bucket IDs | string | |
| | `--checks` | Comma-separated list of check IDs | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| | `--dashboards` | Comma-separated list of dashboard IDs | string | |
| | `--endpoints` | Comma-separated list of notification endpoint IDs | string | |
| `-f` | `--file` | Template output file. Defaults to stdout. Use `.yml` or `.json` file extensions. | string | |
| `-h` | `--help` | Help for the `export` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | `INFLUX_HOST` |
| | `--labels` | Comma-separated list of label IDs | string | |
| | `--resource-type` | Resource type associated with all IDs via stdin | string | |
| | `--rules` | Comma-separated list of notification rule IDs | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--stack-id` | Stack ID to include resources from in export | string | |
| | `--tasks` | Comma-separated list of task IDs | string | |
| | `--telegraf-configs` | Comma-separated list of Telegraf configuration IDs | string | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| | `--variables` | Comma-separated list of variable IDs | string | |
| Flag | | Description | Input Type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:---------- |:------------------ |
| | `--buckets` | Comma-separated list of bucket IDs | string | |
| | `--bucket-names` | Comma-separated list of bucket names | string | |
| | `--checks` | Comma-separated list of check IDs | string | |
| | `--check-names` | Comma-separated list of check names | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| | `--dashboards` | Comma-separated list of dashboard IDs | string | |
| | `--dashboard-names` | Comma-separated list of dashboard names | string | |
| | `--endpoints` | Comma-separated list of notification endpoint IDs | string | |
| | `--endpoint-names` | Comma-separated list of notification endpoint names | string | |
| `-f` | `--file` | Template output file. Defaults to stdout. Use `.yml` or `.json` file extensions. | string | |
| `-h` | `--help` | Help for the `export` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | `INFLUX_HOST` |
| | `--labels` | Comma-separated list of label IDs | string | |
| | `--label-names` | Comma-separated list of label names | string | |
| | `--resource-type` | Resource type associated with all IDs via stdin | string | |
| | `--rules` | Comma-separated list of notification rule IDs | string | |
| | `--rule-names` | Comma-separated list of notification rule names | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--stack-id` | Stack ID to include resources from in export | string | |
| | `--tasks` | Comma-separated list of task IDs | string | |
| | `--task-names` | Comma-separated list of task names | string | |
| | `--telegraf-configs` | Comma-separated list of Telegraf configuration IDs | string | |
| | `--telegraf-config-names` | Comma-separated list of Telegraf configuration names | string | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| | `--variables` | Comma-separated list of variable IDs | string | |
| | `--variable-names` | Comma-separated list of variable names | string | |
## Examples
```sh
@ -60,10 +71,16 @@ influx export \
--labels=$LID1,$LID2,$LID3 \
--dashboards=$DID1,$DID2,$DID3
# Export buckets, labels, and dashboards by name
influx export \
--buckets=bucket1,bucket2,bucket3 \
--labels=label1,label2,label3 \
--dashboards=dashboard1,dashboard2,dashboard3
# Export all resources associated with a stack
influx export --stack-id $STACK_ID
# Export resources associated with a stack and resources
# *not* associated with the stack
influx export --stack-id $STACK_ID --buckets $BUCKET_ID
influx export --stack-id $STACK_ID --buckets $BUCKET_ID --dashboard-names bucket1
```

53
content/influxdb/v2.0/reference/cli/influx/export/all.md
View File

@ -23,42 +23,51 @@ influx export all [flags]
```
## Flags
| Flag | | Description | Input Type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:---------- |:------------------ |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-f` | `--file` | Template output file. Defaults to stdout. Use `.yml` or `.json` file extensions. | string | |
| | `--filter` | Specify resources to export by labelName or resourceKind (format: `--filter=labelName=example`) | list of strings | |
| `-h` | `--help` | Help for the `export all` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | `INFLUX_HOST` |
| `-o` | `--org` | Organization name that owns the resources | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID that owns the resources | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input Type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:---------- |:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-f` | `--file` | Template output file. Defaults to stdout. Use `.yml` or `.json` file extensions. | string | |
| | `--filter` | Specify resources to export by labelName or resourceKind (format: `--filter=labelName=example`) | list of strings | |
| `-h` | `--help` | Help for the `export all` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-o` | `--org` | Organization name that owns the resources | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID that owns the resources | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
## Examples
### Export all resources in an organization as a template
```sh
# Export all resources in an organization as a template
influx export all --org $INFLUX_ORG
```
# Export all bucket resources as a template
### Export all bucket resources as a template
```sh
influx export all --org $INFLUX_ORG --filter=resourceKind=Bucket
```
# Export all resources associated with label Foo
### Export all resources associated with label Foo
```sh
influx export all --org $INFLUX_ORG --filter=labelName=Foo
```
# Export all bucket resources and filter by label Foo
### Export all bucket resources and filter by label Foo
```sh
influx export all --org $INFLUX_ORG \
--filter=resourceKind=Bucket \
--filter=labelName=Foo
```
# Export all bucket or dashboard resources and filter by label Foo.
#
# Note: "like" filters are unioned and filter types are intersections.
# For example, the following will export a resource if it is a dashboard or
# bucket and has an associated label of Foo.
influx export all --org $INFLUX_ORG \
### Export all bucket or dashboard resources and filter by label Foo.
<b>Note</b>: "like" filters are unioned and filter types are intersections.
For example, the following will export a resource if it is a dashboard or bucket and has an associated label of `Foo`.
```influx export all --org $INFLUX_ORG \
--filter=resourceKind=Bucket \
--filter=resourceKind=Dashboard \
--filter=labelName=Foo
``
```

21
content/influxdb/v2.0/reference/cli/influx/export/stack.md
View File

@ -19,16 +19,17 @@ influx export stack <stack_id> [flags]
```
## Flags
| Flag | | Description | Input Type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:---------- |:------------------ |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-f` | `--file` | Template output file. Defaults to stdout. Use `.yml` or `.json` file extensions. | string | |
| `-h` | `--help` | Help for the `export stack` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | `INFLUX_HOST` |
| `-o` | `--org` | Organization name that owns the resources | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID that owns the resources | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input Type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:---------- |:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-f` | `--file` | Template output file. Defaults to stdout. Use `.yml` or `.json` file extensions. | string | |
| `-h` | `--help` | Help for the `export stack` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-o` | `--org` | Organization name that owns the resources | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID that owns the resources | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
## Examples
```sh

23
content/influxdb/v2.0/reference/cli/influx/org/create.md
View File

@ -16,14 +16,15 @@ influx org create [flags]
```
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-d` | `--description` | Description of the organization | | |
| `-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:9999`) | string | `INFLUX_HOST` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | Organization name | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-d` | `--description` | Description of the organization | | |
| `-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` | Organization name | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |

21
content/influxdb/v2.0/reference/cli/influx/org/delete.md
View File

@ -16,13 +16,14 @@ influx org delete [flags]
```
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `delete` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | `INFLUX_HOST` |
| `-i` | `--id` | **(Required)** Organization ID | string | `INFLUX_ORG_ID` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `delete` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-i` | `--id` | **(Required)** Organization ID | string | `INFLUX_ORG_ID` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |

23
content/influxdb/v2.0/reference/cli/influx/org/list.md
View File

@ -21,14 +21,15 @@ influx org list [flags]
`list`, `ls`, `find`
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `list` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | `INFLUX_HOST` |
| `-i` | `--id` | Organization ID | string | `INFLUX_ORG` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | Organization name | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `list` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-i` | `--id` | Organization ID | string | `INFLUX_ORG` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | Organization name | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |

2
content/influxdb/v2.0/reference/cli/influx/org/members/add.md
View File

@ -19,7 +19,7 @@ influx org members add [flags]
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| `-h` | `--help` | Help for the `add` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | `INFLUX_HOST` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-i` | `--id` | Organization ID | string | `INFLUX_ORG_ID` |
| `-m` | `--member` | Member ID | string | |
| `-n` | `--name` | Organization name | string | `INFLUX_ORG` |

2
content/influxdb/v2.0/reference/cli/influx/org/members/list.md
View File

@ -20,7 +20,7 @@ influx org members list [flags]
|:---- |:--- |:----------- |:----------: |:------------------ |
| `-h` | `--help` | Help for the `list` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | `INFLUX_HOST` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-i` | `--id` | Organization ID | string | `INFLUX_ORG_ID` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | Organization name | string | `INFLUX_ORG` |

2
content/influxdb/v2.0/reference/cli/influx/org/members/remove.md
View File

@ -19,7 +19,7 @@ influx org members remove [flags]
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| `-h` | `--help` | Help for the `remove` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | `INFLUX_HOST` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-i` | `--id` | Organization ID | string | `INFLUX_ORG_ID` |
| `-o` | `--member` | Member ID | string | |
| `-n` | `--name` | Organization name | string | `INFLUX_ORG` |

25
content/influxdb/v2.0/reference/cli/influx/org/update.md
View File

@ -16,15 +16,16 @@ influx org update [flags]
```
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------:|:------------------ |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-d` | `--description` | Description for the organization | string | `INFLUX_ORG_DESCRIPTION` |
| `-h` | `--help` | Help for the `update` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | `INFLUX_HOST` |
| `-i` | `--id` | **(Required)** Organization ID | string | `INFLUX_ORG_ID` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | Organization name | string | `INFLUX_ORG` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------:|:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-d` | `--description` | Description for the organization | string | `INFLUX_ORG_DESCRIPTION` |
| `-h` | `--help` | Help for the `update` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-i` | `--id` | **(Required)** Organization ID | string | `INFLUX_ORG_ID` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | Organization name | string | `INFLUX_ORG` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |

2
content/influxdb/v2.0/reference/cli/influx/ping/_index.md
View File

@ -24,5 +24,5 @@ influx ping [flags]
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:---------- |:----------------- |
| `-h` | `--help` | Help for the `ping` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost9999`) | string | `INFLUX_HOST` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--skip-verify` | Skip TLS certificate verification | | |

22
content/influxdb/v2.0/reference/cli/influx/query/_index.md
View File

@ -20,13 +20,15 @@ influx query [query literal] [flags]
```
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------:|:------------------ |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-f` | `--file` | Path to Flux script file | string | |
| `-h` | `--help` | Help for the `query` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | `INFLUX_HOST` |
| `-o` | `--org` | Organization name | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------:|:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-f` | `--file` | Path to Flux script file | string | |
| `-h` | `--help` | Help for the `query` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-o` | `--org` | Organization name | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID | string | `INFLUX_ORG_ID` |
| `-r` | `--raw` | Output raw query results (annotated CSV) | | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |

19
content/influxdb/v2.0/reference/cli/influx/repl/_index.md
View File

@ -28,12 +28,13 @@ Use **ctrl + d** to exit the REPL.
To use the Flux REPL, you must first authenticate with a [token](/influxdb/v2.0/security/tokens/view-tokens/).
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------:|:------------------ |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `repl` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | `INFLUX_HOST` |
| `-o` | `--org` | Organization name | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------:|:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `repl` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-o` | `--org` | Organization name | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |

25
content/influxdb/v2.0/reference/cli/influx/secret/delete.md
View File

@ -17,15 +17,16 @@ influx secret delete [flags]
```
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------:|:------------------ |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `delete` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | `INFLUX_HOST` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-k` | `--key` | **(Required)** Secret key | string | |
| `-o` | `--org` | Organization name | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------:|:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `delete` 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` |
| `-k` | `--key` | **(Required)** Secret key | string | |
| `-o` | `--org` | Organization name | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |

23
content/influxdb/v2.0/reference/cli/influx/secret/list.md
View File

@ -20,14 +20,15 @@ influx secret list [flags]
`list`, `ls`, `find`
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------:|:------------------ |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `list` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | `INFLUX_HOST` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | Organization name | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------:|:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `list` 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` |
| `-o` | `--org` | Organization name | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |

27
content/influxdb/v2.0/reference/cli/influx/secret/update.md
View File

@ -26,16 +26,17 @@ influx secret update [flags]
```
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------:|:------------------ |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `update` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | `INFLUX_HOST` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-k` | `--key` | **(Required)** Secret key | string | |
| `-o` | `--org` | Organization name | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-v` | `--value` | Secret value | string | |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------:|:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `update` 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` |
| `-k` | `--key` | **(Required)** Secret key | string | |
| `-o` | `--org` | Organization name | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-v` | `--value` | Secret value | string | |

27
content/influxdb/v2.0/reference/cli/influx/setup/_index.md
View File

@ -20,19 +20,20 @@ influx setup [flags]
```
## Flags
| Flag | | Description | Data type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:---------:|:------------------ |
| `-b` | `--bucket` | Primary bucket name | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-f` | `--force` | Skip confirmation prompt | | |
| `-h` | `--help` | Help for the `setup` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | `INFLUX_HOST` |
| `-o` | `--org` | Primary organization name | string | |
| `-p` | `--password` | Password for primary user | string | |
| `-r` | `--retention` | Duration bucket will retain data (0 is infinite, default is 0) | duration | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Token for admin user (auto-generated by default) | string | `INFLUX_TOKEN` |
| `-u` | `--username` | Primary username | string | |
| Flag | | Description | Data type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:---------:|:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| `-b` | `--bucket` | Primary bucket name | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-f` | `--force` | Skip confirmation prompt | | |
| `-h` | `--help` | Help for the `setup` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-o` | `--org` | Primary organization name | string | |
| `-p` | `--password` | Password for primary user | string | |
| `-r` | `--retention` | Duration bucket will retain data (0 is infinite, default is 0) | duration | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Token for admin user (auto-generated by default) | string | `INFLUX_TOKEN` |
| `-u` | `--username` | Primary username | string | |
{{% note %}}
Valid `--retention` units are nanoseconds (`ns`), microseconds (`us` or `µs`),

27
content/influxdb/v2.0/reference/cli/influx/stacks/_index.md
View File

@ -29,16 +29,17 @@ influx stacks [command]
| [remove](/influxdb/v2.0/reference/cli/influx/stacks/remove/) | Remove a stack |
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `stacks` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | `INFLUX_HOST` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | Organization name | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--stack-id` | Stack IDs to filter by | list of strings | |
| | `--stack-name` | Stack names to filter by | list of strings | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `stacks` 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` |
| `-o` | `--org` | Organization name | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--stack-id` | Stack IDs to filter by | list of strings | |
| | `--stack-name` | Stack names to filter by | list of strings | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |

22
content/influxdb/v2.0/reference/cli/influx/stacks/init.md
View File

@ -21,10 +21,11 @@ influx stacks init [flags]
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `init` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | `INFLUX_HOST` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | Organization name | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID | string | `INFLUX_ORG_ID` |
@ -35,10 +36,23 @@ influx stacks init [flags]
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
## Examples
### Initialize a stack with a name and description
```sh
# Initialize a stack with a name and description
# Use environment variables
influx stack init -n $STACK_NAME -d $STACK_DESCRIPTION
# Initialize a stack with a name and urls to associate with stack.
influx stack init -n $STACK_NAME -u $PATH_TO_TEMPLATE
# Use strings
influx stack init -n "Example Stack" -d "InfluxDB stack for monitoring some awesome stuff"
```
### Initialize a stack with a name and URLs to associate with the stack
```sh
# Use environment variables
influx stack init -n $STACK_NAME -u $PATH_TO_TEMPLATE
# Use strings
influx stack init -n "Example Stack" -u https://example.com/template-1.yml
```

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