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

resolved merge conflicts

pull/699/head
Scott Anderson 2020-01-02 11:23:22 -07:00
parent 9435861e9b 4f1d048cc0
commit 64145cd40e
12 changed files with 148 additions and 75 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
content/v2.0/cloud/account-management/_index.md
View File

@ -3,7 +3,7 @@ title: Manage your InfluxDB Cloud 2.0 Account
description: >
View and manage information related to your InfluxDB Cloud 2.0 account such as
pricing plans, data usage, account cancelation, etc.
weight: 3
weight: 4
menu:
v2_0_cloud:
name: Account management

29
content/v2.0/cloud/get-started.md
View File

@ -35,10 +35,13 @@ Limits are designed to let you monitor 5-10 sensors, stacks or servers comfortab
2. InfluxDB Cloud requires email verification to complete the sign up process.
Verify your email address by opening the email sent to the address you provided and clicking **Verify Your Email**.
3. (If you subscribed through InfluxData) Choose your cloud provider.
4. Select a region for your {{< cloud-name >}} instance. The following regions are available:
4. Select a provider and region for your {{< cloud-name >}} instance. The following are available:
- **US West (Oregon)**
- **EU Frankfurt**
- **Amazon Web Services (AWS)**
- **US West (Oregon)**
- **EU Frankfurt**
- **Google Cloud Platform (GCP)**
- **Iowa**
_To suggest regions to add, click **Let us know** under Regions._
5. (If you subscribed through InfluxData) Review the terms of the agreement, and then select **I have viewed and agree to InfluxDB Cloud 2.0 Services Subscription Agreement and InfluxData Global Data Processing Agreement**.
@ -81,22 +84,12 @@ For information about using the InfluxDB v2 API, `influx` CLI, and client librar
see [Write data to InfluxDB](/v2.0/write-data/).
{{% note %}}
#### InfluxDB Cloud instance endpoint
When using Telegraf, the InfluxDB v2 API, the `influx` CLI, or the client libraries to interact with your {{< cloud-name "short" >}}
instance, extract the "host" or "endpoint" of your instance from your {{< cloud-name "short" >}} UI URL.
For example:
```bash
# for US West (Oregon)
https://us-west-2-1.aws.cloud2.influxdata.com
# for EU Frankfurt
https://eu-central-1-1.aws.cloud2.influxdata.com
```
When using Telegraf, the InfluxDB v2 API, the `influx` CLI, or the client libraries
to interact with your {{< cloud-name "short" >}}, they each require the URL of your
InfluxDB Cloud instance.
See [InfluxDB Cloud URLs](/v2.0/cloud/urls/) for information about which URL to use
and where to find it in your InfluxDB Cloud UI.
{{% /note %}}
## Query and visualize data

41
content/v2.0/cloud/urls.md Normal file
View File

@ -0,0 +1,41 @@
---
title: InfluxDB Cloud 2.0 URLs
description: >
InfluxDB Cloud 2.0 is available on multiple cloud providers in multiple regions,
each with with a unique URL and API endpoint.
weight: 3
menu:
v2_0_cloud:
name: InfluxDB Cloud URLs
---
InfluxDB Cloud 2.0 is available on multiple cloud providers in multiple regions.
Each region has a unique InfluxDB Cloud URL and API endpoint.
Use the URLs below to interact with your InfluxDB Cloud instances with the
[InfluxDB API](/v2.0/reference/api/), [InfluxDB client libraries](/v2.0/reference/api/client-libraries/),
[`influx` CLI](/v2.0/reference/cli/influx/), or [Telegraf](/v2.0/write-data/use-telegraf/).
## Amazon Web Services (AWS)
| Region | URL |
|:------ |:--- |
| US West (Oregon) | https://us-west-2-1.aws.cloud2.influxdata.com |
| EU Frankfurt | https://eu-central-1-1.aws.cloud2.influxdata.com |
## Google Cloud Platform (GCP)
| Region | URL |
|:------ |:--- |
| US Central (Iowa) | https://us-central1-1.gcp.cloud2.influxdata.com/ |
---
### View your Cloud URL in the InfluxDB Cloud UI
For the URL of your specific InfluxDB Cloud instance:
1. Click the **Load Data** icon in the left navigation of your InfluxDB Cloud user interface (UI).
{{< nav-icon "load-data" >}}
2. Go to **Client Libraries**.
3. The URL of your InfluxDB instance is displayed near the top of the page.

28
content/v2.0/organizations/members/remove-member.md
View File

@ -7,25 +7,39 @@ menu:
name: Remove a member
parent: Manage members
weight: 203
draft: true
---
Use the InfluxDB user interface (UI) or the `influx` command line interface (CLI)
to remove a member from an organization.
{{% note %}}
Removing a member from an organization removes all permissions associated with the organization,
but it does not delete the user from the system entirely.
For information about deleting a user from InfluxDB, see [Delete a user](/v2.0/users/delete-user/).
{{% /note %}}
## Remove a member from an organization in the InfluxDB UI
1. Click the **Settings** tab in the navigation bar.
1. Click **Settings** in the left navigation bar.
{{< nav-icon "settings" >}}
2. Select the **Members** tab.
_Complete content coming soon_
2. Select **Members**.
3. Hover over the member you would like to delete and click the **{{< icon "delete" >}}** icon.
4. Click **Delete**.
## Remove a member from an organization using the influx CLI
Use the [`influx org members add` command](/v2.0/reference/cli/influx/org/members/add)
Use the [`influx org members remove` command](/v2.0/reference/cli/influx/org/members/remove)
to remove a member from an organization. Removing a member requires the following:
_Complete content coming soon_
- The organization name or ID _(provided in the output of [`influx org find`](/v2.0/reference/cli/influx/org/find/))_
- The member ID _(provided in the output of [`influx org members list`](/v2.0/reference/cli/influx/org/members/list/))_
```sh
# Pattern
influx org members remove -o <member-id> -i <organization-id>
# Example
influx org members remove -o 00xXx0x00xXX0000 -i x0xXXXx00x0x000X
```

13
content/v2.0/reference/cli/influx/user/create.md
View File

@ -16,11 +16,12 @@ influx user create [flags]
```
## Flags
| Flag | Description | Input type |
|:---- |:----------- |:----------: |
| `-h`, `--help` | Help for `create` | |
| `-n`, `--name` | The user name **(Required)** | string |
| `-o`, `--org-id` | The organization ID to add the user to<br/> _(Required if password is provided)_ | string |
| `-p`, `--password` | The user password | string |
| Flag | Description | Input type |
|:---- |:----------- |:----------: |
| `-h`, `--help` | Help for `create` | |
| `-n`, `--name` | The username **(Required)** | string |
| `-o`, `--org` | The name of the organization to add the user to | string |
| `--org-id` | The ID of the organization to add the user to | string |
| `-p`, `--password` | The user password | string |
{{% influx-cli-global-flags %}}

2
content/v2.0/reference/cli/influx/user/find.md
View File

@ -20,6 +20,6 @@ influx user find [flags]
|:---- |:----------- |:----------: |
| `-h`, `--help` | Help for `find` | |
| `-i`, `--id` | The user ID | string |
| `-n`, `--name` | The user name | string |
| `-n`, `--name` | The username | string |
{{% influx-cli-global-flags %}}

2
content/v2.0/reference/cli/influx/user/update.md
View File

@ -21,6 +21,6 @@ influx user update [flags]
|:---- |:----------- |:----------: |
| `-h`, `--help` | Help for `update` | |
| `-i`, `--id` | The user ID **(Required)** | string |
| `-n`, `--name` | The user name | string |
| `-n`, `--name` | The username | string |
{{% influx-cli-global-flags %}}

12
content/v2.0/reference/syntax/line-protocol.md
View File

@ -1,13 +1,11 @@
---
title: Line protocol reference
list_title: Line protocol
title: Line protocol
description: >
InfluxDB uses line protocol to write data points.
It is a text-based format that provides the measurement, tag set, field set, and timestamp of a data point.
menu:
v2_0_ref:
parent: Syntax
name: Line protocol
weight: 102
v2.0/tags: [write, line protocol, syntax]
aliases:
@ -69,8 +67,6 @@ Tag keys are subject to [naming restrictions](#naming-restrictions)._
_**Key data type:** [String](#string)_
_**Value data type:** [String](#string)_
_See [naming restrictions](#naming-restrictions)_
### Field set
<span class="required">Required</span> –
All field key-value pairs for the point.
@ -79,9 +75,7 @@ _Field keys and string values are case-sensitive.
Field keys are subject to [naming restrictions](#naming-restrictions)._
_**Key data type:** [String](#string)_
_**Value data type:** [Float](#float) | [Integer](#integer) | [String](#string) | [Boolean](#boolean)_
_See [naming restrictions](#naming-restrictions)_
_**Value data type:** [Float](#float) | [Integer](#integer) | [UInteger](#uinteger) | [String](#string) | [Boolean](#boolean)_
{{% note %}}
_Always double quote string field values. More on quotes [below](#quotes)._
@ -116,7 +110,7 @@ The **second unescaped space** delimits the field set from the timestamp.
```
measurementName,tagKey=tagValue fieldKey="fieldValue" 1465839830100400200
┬ ┬
| |
1st space 2nd space
```

22
content/v2.0/users/create-user.md
View File

@ -20,30 +20,34 @@ Additional users cannot be created in the InfluxDB UI.
## Create a user using the influx CLI
Use the [`influx user create` command](/v2.0/reference/cli/influx/user/create)
to create a new user. A new user requires the following:
To create a new user, use the [`influx user create` command](/v2.0/reference/cli/influx/user/create)
and include the following:
- A username
- Username
- Organization name or organization ID to add the user to _(provided in the output of
[`influx org find`](/v2.0/reference/cli/influx/org/find/))_
```sh
# Pattern
influx user create -n <username>
influx user create -n <username> -o <org-name>
# Example
influx user create -n johndoe
influx user create -n johndoe -o example-org
```
### Create a user with a password and organization
To create a new user with a password and add the user as a member of an organization,
include a password and organization ID with the `influx user create` command.
_Use the [`influx org find` command](/v2.0/reference/cli/influx/org/find/)
to retrieve your organization ID._
- Username
- Organization name or organization ID to add the user to _(provided in the output of
[`influx org find`](/v2.0/reference/cli/influx/org/find/))_
- Password
```sh
# Pattern
influx user create -n <username> -p <password> -o <org-id>
influx user create -n <username> -p <password> -o <org-name>
# Example
influx user create -n johndoe -p PaSsWoRd -o 0o0x00o0x0000oo0
influx user create -n johndoe -p PaSsWoRd -o example-org
```

8
content/v2.0/users/delete-user.md
View File

@ -10,7 +10,13 @@ weight: 103
---
Use the InfluxDB user interface (UI) or the `influx` command line interface (CLI)
to create a user.
to delete a user.
{{% warn %}}
Deleting a user removes them completely from InfluxDB.
To remove a user from an organization without deleting the user entirely, see
[Remove a member from an organization](/v2.0/org/members/remove/).
{{% /warn %}}
## Delete a user from the InfluxDB UI

23
content/v2.0/write-data/_index.md
View File

@ -169,13 +169,34 @@ Include the following in your request:
##### Example API write request
Below is an example API write request using `curl`:
Below is an example API write request using `curl`.
The URL depends on the version and location of your InfluxDB 2.0 instance.
{{< tabs-wrapper >}}
{{% tabs %}}
[InfluxDB OSS](#)
[{{< cloud-name "short">}}](#)
{{% /tabs %}}
{{% tab-content %}}
```sh
curl -XPOST "http://localhost:9999/api/v2/write?org=YOUR_ORG&bucket=YOUR_BUCKET&precision=s" \
--header "Authorization: Token YOURAUTHTOKEN" \
--data-raw "mem,host=host1 used_percent=23.43234543 1556896326"
```
{{% /tab-content %}}
{{% tab-content %}}
{{% cloud-msg %}}
For the specific URL of your {{< cloud-name "short" >}} instance, see [InfluxDB Cloud URLs](/v2.0/cloud/urls/).
{{% /cloud-msg %}}
```sh
curl -XPOST "YOUR-INFLUXDB-CLOUD-URL/api/v2/write?org=YOUR_ORG&bucket=YOUR_BUCKET&precision=s" \
--header "Authorization: Token YOURAUTHTOKEN" \
--data-raw "mem,host=host1 used_percent=23.43234543 1556896326"
```
{{% /tab-content %}}
{{< /tabs-wrapper >}}
### Others

41
content/v2.0/write-data/use-telegraf/manual-config.md
View File

@ -39,16 +39,10 @@ Specify the following:
##### urls
An array of URLs for your InfluxDB v2.0 instances.
_By default, InfluxDB runs on port `9999`._
{{% cloud-msg %}}
###### {{< cloud-name "short" >}} URL
To write data to an {{< cloud-name "short" >}} instance, use the URL of your
{{< cloud-name "short" >}} user interface (UI).
{{< cloud-name >}} requires HTTPS.
For example: <code>https:<nolink>//us-west-2-1.aws.cloud2.influxdata.com</code>
{{% /cloud-msg %}}
By default, InfluxDB 2.0 OSS runs on port `9999`.
If using **{{< cloud-name >}}**, see [InfluxDB Cloud URLs](/v2.0/cloud/urls/) for information
about which URLs to use.
**{{< cloud-name "short">}} requires HTTPS**.
##### token
Your InfluxDB v2.0 authorization token.
@ -80,13 +74,13 @@ export INFLUX_TOKEN=YourAuthenticationToken
{{% code-tab-content %}}
```sh
$env:INFLUX_TOKEN = “YourAuthenticationToken"
$env:INFLUX_TOKEN = "YourAuthenticationToken"
```
{{% /code-tab-content %}}
{{% code-tab-content %}}
```sh
set INFLUX_TOKEN=YourAuthenticationToken
set INFLUX_TOKEN=YourAuthenticationToken
# Make sure to include a space character at the end of this command.
```
{{% /code-tab-content %}}
@ -107,12 +101,12 @@ The name of the bucket to write data to.
#### Example influxdb_v2 configuration
The example below illustrates `influxdb_v2` configurations that write to InfluxDB OSS or {{< cloud-name >}}.
{{< code-tabs-wrapper >}}
{{% code-tabs %}}
{{< tabs-wrapper >}}
{{% tabs %}}
[InfluxDB OSS](#)
[{{< cloud-name "short" >}}](#)
{{% /code-tabs %}}
{{% code-tab-content %}}
{{% /tabs %}}
{{% tab-content %}}
```toml
# ...
@ -124,13 +118,18 @@ The example below illustrates `influxdb_v2` configurations that write to InfluxD
# ...
```
{{% /code-tab-content %}}
{{% code-tab-content %}}
{{% /tab-content %}}
{{% tab-content %}}
{{% cloud-msg %}}
For the specific URL of your {{< cloud-name "short" >}} instance, see [InfluxDB Cloud URLs](/v2.0/cloud/urls/).
{{% /cloud-msg %}}
```toml
# ...
[[outputs.influxdb_v2]]
urls = ["https://us-west-2-1.aws.cloud2.influxdata.com"]
urls = ["https://example.cloud2.influxdata.com"]
token = "$INFLUX_TOKEN"
organization = "example-org"
bucket = "example-bucket"
@ -138,8 +137,8 @@ The example below illustrates `influxdb_v2` configurations that write to InfluxD
# ...
```
{{% /code-tab-content %}}
{{< /code-tabs-wrapper >}}
{{% /tab-content %}}
{{< /tabs-wrapper >}}
{{% note %}}