WIP org and user docs
parent
505b4eb6dd
commit
e62c8266f1
|
@ -1,13 +1,16 @@
|
|||
---
|
||||
title: Manage organizations in InfluxDB
|
||||
description: placeholder
|
||||
description: >
|
||||
How to manage organizations, workspaces for groups of users.
|
||||
All dashboards, tasks, buckets, members, etc., belong to an organization.
|
||||
menu:
|
||||
v2_0:
|
||||
name: Manage organizations
|
||||
weight: 10
|
||||
---
|
||||
|
||||
Everything is scoped by/contained within organization--dashboards, tasks, buckets, users, !!collectors and scrapers!!.
|
||||
An **organization** is a workspace for a group of users.
|
||||
All dashboards, tasks, buckets, members, etc., belong to an organization.
|
||||
|
||||
**To create an organization**:
|
||||
|
||||
|
|
|
@ -1,6 +1,8 @@
|
|||
---
|
||||
title: Manage buckets in InfluxDB
|
||||
description: placeholder
|
||||
description: >
|
||||
How to manage buckets in InfluxDB.
|
||||
A bucket is a named location where time series data is stored with a retention policy.
|
||||
menu:
|
||||
v2_0:
|
||||
name: Manage buckets
|
||||
|
@ -8,11 +10,12 @@ menu:
|
|||
weight: 1
|
||||
---
|
||||
|
||||
A **bucket** is a named location where time series data is stored.
|
||||
All buckets have a **retention policy**, a duration of time that each data point persists.
|
||||
A bucket belongs to an organization.
|
||||
|
||||
**To manage an organization's buckets**:
|
||||
|
||||
A bucket is a named location where data is stored that has a retention policy. It’s similar to an InfluxDB v1.x “database,” but is a combination of both a database and a retention policy. Each bucket can only have one retention policy.
|
||||
|
||||
|
||||
1. Click the **Organizations** tab in the navigation bar.
|
||||
2. Click on the name of an organization, then select the **Buckets** tab. All of the organization's buckets appear.
|
||||
3. To create a bucket, click **+Create** in the upper right.
|
||||
|
|
|
@ -0,0 +1,44 @@
|
|||
---
|
||||
title: Create a bucket
|
||||
seotitle: Create a bucket in InfluxDB
|
||||
description: placeholder
|
||||
menu:
|
||||
v2_0:
|
||||
name: Create a bucket
|
||||
parent: Manage buckets
|
||||
weight: 1
|
||||
---
|
||||
|
||||
Use the InfluxDB user interface (UI) or the `influx` command line interface (CLI)
|
||||
to create a bucket.
|
||||
|
||||
## Create a bucket in the InfluxDB UI
|
||||
|
||||
1. Click the **Organizations** tab in the navigation bar.
|
||||
|
||||
{{< img-hd src="/img/organizations-icon.png" title="Organizations icon" />}}
|
||||
|
||||
2. Click on the name of an organization, then select the **Buckets** tab.
|
||||
3. Click **+ Create Bucket** in the upper right.
|
||||
4. Enter a **Name** for the bucket.
|
||||
5. Select **How often to clear data?**:
|
||||
Select **Never** to retain data forever.
|
||||
Select **Periodically** to define a specific retention policy.
|
||||
4. To update a bucket's name or retention policy, click the name of the bucket from the list.
|
||||
5. Click **Create** to create the bucket.
|
||||
|
||||
## Create a bucket in the influx CLI
|
||||
Use the the [`influx bucket create` command](/v2.0/reference/cli/influx/bucket/create)
|
||||
to create a new bucket. A bucket requires the following:
|
||||
|
||||
- A name
|
||||
- The name or ID of the organization to which it belongs
|
||||
- A retention period in nanoseconds
|
||||
|
||||
```sh
|
||||
# Pattern
|
||||
influx bucket create -n <bucket-name> -o <org-name> -r <retention period in nanoseconds>
|
||||
|
||||
# Example
|
||||
influx bucket create -n my-bucket -o my-org -r 604800000000000
|
||||
```
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
title: Delete a bucket
|
||||
seotitle: Delete a bucket from InfluxDB
|
||||
description: placeholder
|
||||
menu:
|
||||
v2_0:
|
||||
name: Delete a bucket
|
||||
parent: Manage buckets
|
||||
weight: 3
|
||||
---
|
||||
|
||||
Use the InfluxDB user interface (UI) or the `influx` command line interface (CLI)
|
||||
to delete a bucket.
|
||||
|
||||
## Delete a bucket in the InfluxDB UI
|
||||
|
||||
1. Click the **Organizations** tab in the navigation bar.
|
||||
|
||||
{{< img-hd src="/img/organizations-icon.png" title="Organizations icon" />}}
|
||||
|
||||
2. Click on the name of an organization, then select the **Buckets** tab.
|
||||
3. Hover over the bucket you would like to delete.
|
||||
4. Click **Delete** and **Confirm** to delete the bucket.
|
||||
|
||||
## Delete a bucket using the influx CLI
|
||||
|
||||
Use the the [`influx bucket delete` command](/v2.0/reference/cli/influx/bucket/delete)
|
||||
to delete a new bucket. Deleting a bucket requires the following:
|
||||
|
||||
- The bucket ID _(provided in the output of `influx bucket find`)_.
|
||||
|
||||
```sh
|
||||
# Pattern
|
||||
influx bucket delete -i <bucket-id>
|
||||
|
||||
# Example
|
||||
influx bucket delete -i 034ad714fdd6f000
|
||||
```
|
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
title: Update a bucket
|
||||
seotitle: Update a bucket in InfluxDB
|
||||
description: placeholder
|
||||
menu:
|
||||
v2_0:
|
||||
name: Update a bucket
|
||||
parent: Manage buckets
|
||||
weight: 2
|
||||
---
|
||||
|
||||
|
||||
1. Click the **Organizations** tab in the navigation bar.
|
||||
|
||||
{{< img-hd src="/img/organizations-icon.png" title="Organizations icon" />}}
|
||||
|
||||
2. Click on the name of an organization, then select the **Buckets** tab. All of the organization's buckets appear.
|
||||
3. To create a bucket, click **+Create** in the upper right.
|
||||
* Enter a name for your bucket in the **Name** field.
|
||||
* In the **How often to clear data?** field:
|
||||
* Select **Never** to retain data forever.
|
||||
* Select **Periodically** to define a specific retention policy.
|
||||
4. To update a bucket's name or retention policy, click the name of the bucket from the list.
|
||||
5. Click **Update** to save.s
|
Binary file not shown.
After Width: | Height: | Size: 29 KiB |
Loading…
Reference in New Issue