diff --git a/content/v2.0/UI/getting-started.md b/content/v2.0/UI/getting-started.md deleted file mode 100644 index 5e1e0fb85..000000000 --- a/content/v2.0/UI/getting-started.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: Getting started -description: This is just an example post to show the format of new 2.0 posts -menu: - v2_0: - name: Getting started - weight: 1 - parent: Placeholder parent ---- - -## Buckets - -Buckets are a new data storage concept for InfluxDB. 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. When using multiple retention policies, each retention policy is treated as is its own bucket. - - -## Onboarding (/setup) - -* Set up your initial admin user. -Enter: - * Admin username - * Admin password/confirm - * Default organization name - * Default bucket name -* Click Next -* Select data sources to add to your bucket. -Pick from boxes showing sources - * Streaming - * Line protocol - * CSV -* Click Next -* Configure your data source. - * Lots of details, differs depending on source type. - * Type v1 or v2? -* Import protoboards for selected data sources -* Setup complete screen - * click Go to Status Dashboard? - * or does it link you to the User Homepage? Pretty sure it’s this. - - -## User Homepage (/) - -* A jumping off point for everything the user has access to - * List of all dashboards they have access to - * List of all orgs they belong to - * List of all tasks they have access to -* Contains links to support related items: - * Technical documentation - * Community forum - * Report a bug - * Request a feature - * Version info - * Last commit -* Contains links to docs -* Manage my plan: A place to get notifications from Quartz -* A place to learn about new features and updates in each version - -### Subpages - -#### Account settings (/my-account) - -* About Me: - * Username - * Email address -* Preferences - * Timezone - * Theme -* For both, Edit Changes then Save Changes - -#### Tokens (/tokens) - -* Table with Description, Last Used, and Organization columns - * Click on token name in Description column for Edit Token overlay - * Unlikely that user will use it, mostly in case of emergency - * Click on org name in Organization column to open organization page -* Generate token upper right - * Opens generate token overlay (tgo!) - * Also very unlikely that user will manually generate a token diff --git a/content/v2.0/UI/organizations.md b/content/v2.0/UI/organizations.md deleted file mode 100644 index a787739d4..000000000 --- a/content/v2.0/UI/organizations.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: Managing organizations -description: Describes how to manage organizations. -menu: - v2_0: - name: Managing organizations - weight: 1 - parent: Placeholder parent ---- - -Everything is scoped by/contained within organization--dashboards, tasks, buckets, users, !!collectors and scrapers!!. - -**To create an organization**: - -1. Click the **Organizations** tab in the navigation bar. -2. Click **+ Create Organization** -2. Enter a name for your organization. -3. Click **Create**. - -**To manage an organization's members**: - -Organizations have "owners" and "members". - -1. Click the **Organizations** tab in the navigation bar. -2. Click on the name of an organization. All of the organization's members appear in the **Members** tab. -3. Select a member from the list or search to filter the list. -4. ?? Edit members, remove members, invite users to be a member - - -**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. - * 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. -6. ??Configure data sources tied to each bucket, delete bucket - - -**To view an organization's dashboards**: - -1. Click the **Organizations** tab in the navigation bar. -2. Click on the name of an organization, then select the **Dashboards** tab. All of the organization's dashboards appear. -3. Click on the name of the dashboard to view it. - -For details on editing dashboards, see <> - - -#### Tasks (/organizations/orgnamehere/tasks) - * User can see all tasks owned by this org - -#### Options (/organizations/orgnamehere/options) mockup says settings - * Only owners can see this tab - * Owner can change name of Organization - * Owner can modify permissions of an organization - * There will be more options here in the future - * Owner can disband organization diff --git a/content/v2.0/organizations/_index.md b/content/v2.0/organizations/_index.md new file mode 100644 index 000000000..456b20e0a --- /dev/null +++ b/content/v2.0/organizations/_index.md @@ -0,0 +1,16 @@ +--- +title: Manage organizations +seotitle: Manage organizations in InfluxDB +description: Manage organizations in InfluxDB using the InfluxDB UI or the influx CLI. +menu: + v2_0: + name: Manage organizations + weight: 10 +--- + +An **organization** is a workspace for a group of users. +All dashboards, tasks, buckets, members, etc., belong to an organization. + +The following articles provide information about managing organizations: + +{{< children >}} diff --git a/content/v2.0/organizations/buckets/_index.md b/content/v2.0/organizations/buckets/_index.md new file mode 100644 index 000000000..0d103155c --- /dev/null +++ b/content/v2.0/organizations/buckets/_index.md @@ -0,0 +1,18 @@ +--- +title: Manage buckets +seotitle: Manage buckets in InfluxDB +description: Manage buckets in InfluxDB using the InfluxDB UI or the influx CLI. +menu: + v2_0: + name: Manage buckets + parent: Manage organizations + weight: 5 +--- + +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. + +The following articles provide information about managing buckets: + +{{< children >}} diff --git a/content/v2.0/organizations/buckets/create-bucket.md b/content/v2.0/organizations/buckets/create-bucket.md new file mode 100644 index 000000000..46d0cb895 --- /dev/null +++ b/content/v2.0/organizations/buckets/create-bucket.md @@ -0,0 +1,44 @@ +--- +title: Create a bucket +seotitle: Create a bucket in InfluxDB +description: Create buckets to store time series data in InfluxDB using the InfluxDB UI or the influx CLI. +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. +5. Click **Create** to create the bucket. + +## Create a bucket using the influx CLI + +Use 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 -o -r + +# Example +influx bucket create -n my-bucket -o my-org -r 604800000000000 +``` diff --git a/content/v2.0/organizations/buckets/delete-bucket.md b/content/v2.0/organizations/buckets/delete-bucket.md new file mode 100644 index 000000000..ed8343fda --- /dev/null +++ b/content/v2.0/organizations/buckets/delete-bucket.md @@ -0,0 +1,39 @@ +--- +title: Delete a bucket +seotitle: Delete a bucket from InfluxDB +description: Delete a bucket from InfluxDB using the InfluxDB UI or the influx CLI +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 [`influx bucket delete` command](/v2.0/reference/cli/influx/bucket/delete) +to delete a bucket. Deleting a bucket requires the following: + +- The bucket ID _(provided in the output of `influx bucket find`)_ +- The name or ID of the organization to which the bucket belongs + +```sh +# Pattern +influx bucket delete -i + +# Example +influx bucket delete -i 034ad714fdd6f000 +``` diff --git a/content/v2.0/organizations/buckets/update-bucket.md b/content/v2.0/organizations/buckets/update-bucket.md new file mode 100644 index 000000000..e8e328bf1 --- /dev/null +++ b/content/v2.0/organizations/buckets/update-bucket.md @@ -0,0 +1,49 @@ +--- +title: Update a bucket +seotitle: Update a bucket in InfluxDB +description: Update a bucket's name or retention policy in InfluxDB using the InfluxDB UI or the influx CLI. +menu: + v2_0: + name: Update a bucket + parent: Manage buckets + weight: 2 +--- + +Use the InfluxDB user interface (UI) or the `influx` command line interface (CLI) +to update a bucket. + +## Update 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. All of the organization's buckets appear. +3. To update a bucket's name or retention policy, click the name of the bucket from the list. +4. Click **Update** to save. + +## Update a bucket using the influx CLI + +Use the [`influx bucket update` command](/v2.0/reference/cli/influx/bucket/update) +to update a bucket. Updating a bucket requires the following: + +- The bucket ID _(provided in the output of `influx bucket find`)_ +- The name or ID of the organization to which the bucket belongs + +##### Update the name of a bucket +```sh +# Pattern +influx bucket update -i -o -n + +# Example +influx bucket update -i 034ad714fdd6f000 -o my-org -n my-new-bucket +``` + +##### Update a bucket's retention policy +```sh +# Pattern +influx bucket update -i -o -r + +# Example +influx bucket update -i 034ad714fdd6f000 -o my-org -r 1209600000000000 +``` diff --git a/content/v2.0/organizations/buckets/view-buckets.md b/content/v2.0/organizations/buckets/view-buckets.md new file mode 100644 index 000000000..6252c39c4 --- /dev/null +++ b/content/v2.0/organizations/buckets/view-buckets.md @@ -0,0 +1,33 @@ +--- +title: View buckets +seotitle: View buckets in InfluxDB +description: View a list of all the buckets for an organization in InfluxDB using the InfluxDB UI or the influx CLI. +menu: + v2_0: + name: View buckets + parent: Manage buckets + weight: 2 +--- + +## View buckets 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. All of the organization's buckets appear. +3. Click on a bucket to view details.= + +## View buckets using the influx CLI + +Use the [`influx bucket find` command](/v2.0/reference/cli/influx/bucket/find) +to view a buckets in an organization. Viewing bucket requires the following: + + +```sh +influx bucket find +``` + +Other filtering options such as filtering by organization, name, or ID are available. +See the [`influx bucket find` documentation](/v2.0/reference/cli/influx/bucket/find) +for information about other available flags. diff --git a/content/v2.0/organizations/create-org.md b/content/v2.0/organizations/create-org.md new file mode 100644 index 000000000..ba90b261a --- /dev/null +++ b/content/v2.0/organizations/create-org.md @@ -0,0 +1,36 @@ +--- +title: Create an organization +seotitle: Create an organization in InfluxDB +description: Create an organization in InfluxDB using the InfluxDB UI or the influx CLI. +menu: + v2_0: + name: Create an organization + parent: Manage organizations + weight: 1 +--- + +Use the InfluxDB user interface (UI) or the `influx` command line interface (CLI) +to create an organization. + +## Create an organization in the InfluxDB UI + +1. Click the **Organizations** tab in the navigation bar. + + {{< img-hd src="/img/organizations-icon.png" title="Organizations icon" />}} + +_Complete content coming soon_ + +## Create an organization using the influx CLI + +Use the [`influx org create` command](/v2.0/reference/cli/influx/org/create) +to create a new organization. A new organization requires the following: + +- A name for the organization + +```sh +# Pattern +influx org create -n + +# Example +influx org create -n my-org +``` diff --git a/content/v2.0/organizations/delete-org.md b/content/v2.0/organizations/delete-org.md new file mode 100644 index 000000000..c26e05445 --- /dev/null +++ b/content/v2.0/organizations/delete-org.md @@ -0,0 +1,36 @@ +--- +title: Delete an organization +seotitle: Delete an organization from InfluxDB +description: Delete an existing organization from InfluxDB using the InfluxDB UI or the influx CLI. +menu: + v2_0: + name: Delete an organization + parent: Manage organizations + weight: 4 +--- + +Use the InfluxDB user interface (UI) or the `influx` command line interface (CLI) +to create an organization. + +## Delete an organization in the InfluxDB UI + +* Click the **Organizations** tab in the navigation bar. + + {{< img-hd src="/img/organizations-icon.png" title="Organizations icon" />}} +The list of organizations appears. +* Hover over an organization's name and click **Delete**. + +## Delete an organization using the influx CLI + +Use the [`influx org delete` command](/v2.0/reference/cli/influx/org/delete) +to delete an organization. Deleting an organization requires the following: + +- The organization ID _(provided in the output of `influx org find`)_ + +```sh +# Pattern +influx org delete -i + +# Example +influx org delete -i 034ad714fdd6f000 +``` diff --git a/content/v2.0/organizations/members/_index.md b/content/v2.0/organizations/members/_index.md new file mode 100644 index 000000000..962a03542 --- /dev/null +++ b/content/v2.0/organizations/members/_index.md @@ -0,0 +1,15 @@ +--- +title: Manage organization members +seotitle: Manage members of an organization in InfluxDB +description: Manage members of an organization in InfluxDB using the InfluxDB UI or CLI. +menu: + v2_0: + name: Manage members + parent: Manage organizations + weight: 6 +--- + +A **member** is a user that belongs to an organization. +The following articles provide information about managing users: + +{{< children >}} diff --git a/content/v2.0/organizations/members/add-member.md b/content/v2.0/organizations/members/add-member.md new file mode 100644 index 000000000..aecde1d4d --- /dev/null +++ b/content/v2.0/organizations/members/add-member.md @@ -0,0 +1,31 @@ +--- +title: Add a member +seotitle: Add a member to an organization in InfluxDB +description: Add a member to an organization. +menu: + v2_0: + name: Add a member + parent: Manage members + weight: 1 +draft: true +--- + +Use the InfluxDB user interface (UI) or the `influx` command line interface (CLI) +to add a member to an organization. + +## Add a member to an organization 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 **Members** tab. + +_Complete content coming soon_ + +## Add a member to an organization using the influx CLI + +Use the [`influx org members add` command](/v2.0/reference/cli/influx/org/members/add) +to add a user to an organization. Adding a user requires the following: + +_Complete content coming soon_ diff --git a/content/v2.0/organizations/members/remove-member.md b/content/v2.0/organizations/members/remove-member.md new file mode 100644 index 000000000..6da459331 --- /dev/null +++ b/content/v2.0/organizations/members/remove-member.md @@ -0,0 +1,31 @@ +--- +title: Remove a member +seotitle: Remove a member from an organization in InfluxDB +description: Remove a member from an organization. +menu: + v2_0: + name: Remove a member + parent: Manage members + weight: 3 +draft: true +--- + +Use the InfluxDB user interface (UI) or the `influx` command line interface (CLI) +to remove a member from an organization. + +## Remove a member from an organization 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 **Members** tab. + +_Complete content coming soon_ + +## 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) +to remove a member from an organization. Removing a member requires the following: + +_Complete content coming soon_ diff --git a/content/v2.0/organizations/members/view-members.md b/content/v2.0/organizations/members/view-members.md new file mode 100644 index 000000000..3cf61a1c9 --- /dev/null +++ b/content/v2.0/organizations/members/view-members.md @@ -0,0 +1,37 @@ +--- +title: View members +seotitle: View members of an organization in InfluxDB +description: Review a list of members for an organization. +menu: + v2_0: + name: View members + parent: Manage members + weight: 2 +--- + +Use the InfluxDB user interface (UI) or the `influx` command line interface (CLI) +to view members of an organization. + +## View members of organization in the InfluxDB UI + +* Click the **Organizations** tab in the navigation bar. + + {{< img-hd src="/img/organizations-icon.png" title="Organizations icon" />}} + +* Click on the name of an organization, then select the **Members** tab. The list of organization members appears. + + +## View members of organization using the influx CLI + +Use the [`influx org members list` command](/v2.0/reference/cli/influx/org/members/list) +to list members of an organization. Listing an organization's members requires the following: + +- The name or ID of the organization + +```sh +# Pattern +influx org members list -n + +# Example +influx org members list -n my-org +``` diff --git a/content/v2.0/organizations/update-org.md b/content/v2.0/organizations/update-org.md new file mode 100644 index 000000000..3924293c8 --- /dev/null +++ b/content/v2.0/organizations/update-org.md @@ -0,0 +1,39 @@ +--- +title: Update an organization +seotitle: Update an organization in InfluxDB +description: Update an organization's name and assets in InfluxDB using the InfluxDB UI or the influx CLI. +menu: + v2_0: + name: Update an organization + parent: Manage organizations + weight: 3 +--- + +Use the InfluxDB user interface (UI) or the `influx` command line interface (CLI) +to update an organization. + +## Update an organization 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 organization you want to update in the list. +3. To update the organization's name, select the **Options** tab. +4. To manage the organization's members, buckets, dashboards, and tasks, click on the corresponding tabs. + +## Update an organization using the influx CLI + +Use the [`influx org update` command](/v2.0/reference/cli/influx/org/update) +to update an organization. Updating an organization requires the following: + +- The org ID _(provided in the output of `influx org find`)_ + +##### Update the name of a organization +```sh +# Pattern +influx org update -i -n + +# Example +influx org update -i 034ad714fdd6f000 -n my-new-org +``` diff --git a/content/v2.0/organizations/view-orgs.md b/content/v2.0/organizations/view-orgs.md new file mode 100644 index 000000000..5b06e521c --- /dev/null +++ b/content/v2.0/organizations/view-orgs.md @@ -0,0 +1,35 @@ +--- +title: View organizations +seotitle: View organizations in InfluxDB +description: Review a list of organizations in InfluxDB using the InfluxDB UI or the influx CLI. +menu: + v2_0: + name: View organizations + parent: Manage organizations + weight: 2 +--- + +Use the InfluxDB user interface (UI) or the `influx` command line interface (CLI) +to view organizations. + +## View organizations in the InfluxDB UI + +* Click the **Organizations** tab in the navigation bar. + + {{< img-hd src="/img/organizations-icon.png" title="Organizations icon" />}} + +The list of organizations appears. + + +## View organizations using the influx CLI + +Use the [`influx org find` command](/v2.0/reference/cli/influx/org/find) +to view organizations. + +```sh +influx org find +``` + +Filtering options such as filtering by name or ID are available. +See the [`influx org find` documentation](/v2.0/reference/cli/influx/org/find) +for information about other available flags. diff --git a/content/v2.0/process-data/manage-tasks/view-tasks.md b/content/v2.0/process-data/manage-tasks/view-tasks.md index 9cbf410a1..2a0a84f69 100644 --- a/content/v2.0/process-data/manage-tasks/view-tasks.md +++ b/content/v2.0/process-data/manage-tasks/view-tasks.md @@ -1,5 +1,5 @@ --- -title: View tasks in InfluxDB +title: View tasks seotitle: View created tasks that process data in InfluxDB description: > How to view all created data processing tasks using the InfluxDB user interface @@ -32,6 +32,6 @@ influx task find #### Filter tasks using the CLI Other filtering options such as filtering by organization or user, -or limiting the number of tasks returned are available. +or limiting the number of tasks returned, are available. See the [`influx task find` documentation](/v2.0/reference/cli/influx/task/find) for information about other available flags. diff --git a/content/v2.0/ui/account-settings.md b/content/v2.0/ui/account-settings.md deleted file mode 100644 index 6fc4f8e3f..000000000 --- a/content/v2.0/ui/account-settings.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Managing account settings -description: This is just an example post to show the format of new 2.0 posts -menu: - v2_0: - name: Managing account settings - weight: 1 - parent: Placeholder parent ---- - -1. Click the ?? icon in the navigation bar. -2. Review your settings on the **Settings** tab. -3. To edit your settings, click **Edit About Me** diff --git a/content/v2.0/ui/tokens.md b/content/v2.0/ui/tokens.md deleted file mode 100644 index 7992d6a95..000000000 --- a/content/v2.0/ui/tokens.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Managing account settings -description: This is just an example post to show the format of new 2.0 posts -menu: - v2_0: - name: Managing tokens - weight: 1 - parent: Placeholder parent ---- -**To view tokens**: - -1. Click the ?? icon in the navigation bar. -2. In the right panel labeled **My Settings**, click **Tokens**. All of your account's tokens appear. -3. Click on a token name from the list to view the token and a summary of access permissions. -<> - -**To copy a token**: - -* From the token detail view, click **Copy**. - -**To delete a token**: - -* Hover over the name of a token in the list, then click **Delete**. diff --git a/content/v2.0/users/_index.md b/content/v2.0/users/_index.md new file mode 100644 index 000000000..a55bde8ff --- /dev/null +++ b/content/v2.0/users/_index.md @@ -0,0 +1,17 @@ +--- +title: Manage users +seotitle: Manage users in InfluxDB +description: Manage users in InfluxDB using the InfluxDB UI or the influx CLI. +menu: + v2_0: + name: Manage users + weight: 12 +--- + +Users are those with access to InfluxDB. +In order to access any data, a user must be [added as a member](/v2.0/organizations/members/add) of an organization. +All users have unique authentication tokens with specific permissions used to grant them access to data within InfluxDB. + +The following articles walk through managing users. + +{{< children >}} diff --git a/content/v2.0/users/create-user.md b/content/v2.0/users/create-user.md new file mode 100644 index 000000000..c01d8c47d --- /dev/null +++ b/content/v2.0/users/create-user.md @@ -0,0 +1,34 @@ +--- +title: Create a user +seotitle: Create a user in InfluxDB +description: Create a user in InfluxDB using the InfluxDB UI or the influx CLI. +menu: + v2_0: + name: Create a user + parent: Manage users + weight: 1 +--- + +Use the InfluxDB user interface (UI) or the `influx` command line interface (CLI) +to create a user. + +## Create a user in the InfluxDB UI + +{{% note %}} +While in alpha, additional users cannot be created in the InfluxDB UI. +{{% /note %}} + +## Create a user using the influx CLI + +Use the [`influx user create` command](/v2.0/reference/cli/influx/create/create) +to create a new user. A new user requires the following: + +- A username + +```sh +# Pattern +influx user create -n + +# Example +influx user create -n johndoe +``` diff --git a/content/v2.0/users/delete-user.md b/content/v2.0/users/delete-user.md new file mode 100644 index 000000000..22ffc492f --- /dev/null +++ b/content/v2.0/users/delete-user.md @@ -0,0 +1,34 @@ +--- +title: Delete a user +seotitle: Delete a user from InfluxDB +description: Delete a user from InfluxDB using the InfluxDB UI or the influx CLI. +menu: + v2_0: + name: Delete a user + parent: Manage users + weight: 3 +--- + +Use the InfluxDB user interface (UI) or the `influx` command line interface (CLI) +to create a user. + +## Delete a user from the InfluxDB UI + +{{% note %}} +While in alpha, users cannot be deleted from the InfluxDB UI. +{{% /note %}} + +## Delete a user using the influx CLI + +Use the [`influx user delete` command](/v2.0/reference/cli/influx/user/delete) +to delete a user. Deleting a user requires the following: + +- The user ID _(provided in the output of `influx user find`)_ + +```sh +# Pattern +influx user delete -i + +# Example +influx user delete -i 034ad714fdd6f000 +``` diff --git a/content/v2.0/users/tokens/_index.md b/content/v2.0/users/tokens/_index.md new file mode 100644 index 000000000..39cba2acc --- /dev/null +++ b/content/v2.0/users/tokens/_index.md @@ -0,0 +1,17 @@ +--- +title: Manage tokens +seotitle: Manage tokens in InfluxDB +description: Manage authentication tokens in InfluxDB using the InfluxDB UI or the influx CLI. +menu: + v2_0: + name: Manage tokens + parent: Manage users + weight: 5 +--- + +InfluxDB ensures secure interaction between users and data through the use of **authentication tokens**. +Every user has a unique token. + +The following articles provide information about managing authentication tokens. + +{{< children >}} diff --git a/content/v2.0/users/tokens/create-token.md b/content/v2.0/users/tokens/create-token.md new file mode 100644 index 000000000..d79f77371 --- /dev/null +++ b/content/v2.0/users/tokens/create-token.md @@ -0,0 +1,37 @@ +--- +title: Create a token +seotitle: Create an authentication token in InfluxDB +description: Create an authentication token in InfluxDB using the InfluxDB UI or the influx CLI. +menu: + v2_0: + name: Create a token + parent: Manage tokens + weight: 1 +draft: true +--- + +**To view tokens**: + +1. Click the ?? icon in the navigation bar. +2. In the right panel labeled **My Settings**, click **Tokens**. All of your account's tokens appear. +3. Click on a token name from the list to view the token and a summary of access permissions. +<> + +**To copy a token**: + +* From the token detail view, click **Copy**. + +**To delete a token**: + +* Hover over the name of a token in the list, then click **Delete**. + + +#### Tokens (/tokens) + +* Table with Description, Last Used, and Organization columns + * Click on token name in Description column for Edit Token overlay + * Unlikely that user will use it, mostly in case of emergency + * Click on org name in Organization column to open organization page +* Generate token upper right + * Opens generate token overlay (tgo!) + * Also very unlikely that user will manually generate a token diff --git a/content/v2.0/users/tokens/view-tokens.md b/content/v2.0/users/tokens/view-tokens.md new file mode 100644 index 000000000..e31aca82c --- /dev/null +++ b/content/v2.0/users/tokens/view-tokens.md @@ -0,0 +1,32 @@ +--- +title: View tokens +seotitle: View authentication tokens in InfluxDB +description: View authentication tokens in InfluxDB using the InfluxDB UI or the influx CLI. +menu: + v2_0: + name: View tokens + parent: Manage tokens + weight: 2 +--- + +Use the InfluxDB user interface (UI) or the `influx` command line interface (CLI) +to view tokens. + +## View tokens in the InfluxDB UI + +1. Click the **Influx** icon in the navigation bar. +2. In the right panel labeled **My Settings**, click **Tokens**. All of your account's tokens appear. +3. Click on a token name from the list to view the token and a summary of access permissions. + +## View tokens using the influx CLI + +Use the [`influx auth find` command](/v2.0/reference/cli/influx/auth/find) +to view tokens. + +```sh +influx auth find +``` + +Filtering options such as filtering by authorization ID, username, or user ID are available. +See the [`influx auth find` documentation](/v2.0/reference/cli/influx/auth/find) +for information about other available flags. diff --git a/content/v2.0/users/update-user.md b/content/v2.0/users/update-user.md new file mode 100644 index 000000000..1905c143f --- /dev/null +++ b/content/v2.0/users/update-user.md @@ -0,0 +1,35 @@ +--- +title: Update a user +seotitle: Update a user in InfluxDB +description: Update a user in InfluxDB using the InfluxDB UI or the influx CLI. +menu: + v2_0: + name: Update a user + parent: Manage users + weight: 3 +--- + +Use the InfluxDB user interface (UI) or the `influx` command line interface (CLI) +to update a user. + +## Update a user in the InfluxDB UI + +{{% note %}} +While in alpha, user information cannot be updated in the InfluxDB UI. +{{% /note %}} + +## Update a user using the influx CLI + +Use the [`influx user update` command](/v2.0/reference/cli/influx/user/update) +to update a user. Updating a user requires the following: + +- The user ID _(provided in the output of `influx user find`)_ + +##### Update the name of a user +```sh +# Pattern +influx user update -i -n + +# Example +influx user update -i 034ad714fdd6f000 -n janedoe +``` diff --git a/content/v2.0/users/view-users.md b/content/v2.0/users/view-users.md new file mode 100644 index 000000000..a014bde2d --- /dev/null +++ b/content/v2.0/users/view-users.md @@ -0,0 +1,32 @@ +--- +title: View users +seotitle: View users in InfluxDB +description: Review a list of users in InfluxDB using the InfluxDB UI or the influx CLI. +menu: + v2_0: + name: View users + parent: Manage users + weight: 2 +--- + +Use the InfluxDB user interface (UI) or the `influx` command line interface (CLI) +to view users. + +## View users in the InfluxDB UI + +{{% note %}} +While in alpha, there is no list of users in the InfluxDB UI. +{{% /note %}} + +## View users using the influx CLI + +Use the [`influx user find` command](/v2.0/reference/cli/influx/user/find) +to view users. + +```sh +influx user find +``` + +Filtering options such as filtering by username or ID are available. +See the [`influx user find` documentation](/v2.0/reference/cli/influx/user/find) +for information about other available flags. diff --git a/content/v2.0/visualize-data/_index.md b/content/v2.0/visualize-data/_index.md index 4cbd56e4b..1040ed814 100644 --- a/content/v2.0/visualize-data/_index.md +++ b/content/v2.0/visualize-data/_index.md @@ -9,7 +9,23 @@ menu: weight: 4 --- -The InfluxDB user interface provides tools for building custom dashboards to visualize your data. +The InfluxDB user interface (UI) provides tools for building custom dashboards to visualize your data. The following articles outline ways to customize and manage dashboards. +## InfluxDB UI home page +* A jumping off point for everything the user has access to + * List of all dashboards they have access to + * List of all orgs they belong to + * List of all tasks they have access to +* Contains links to support related items: + * Technical documentation + * Community forum + * Report a bug + * Request a feature + * Version info + * Last commit +* Contains links to docs +* Manage my plan: A place to get notifications from Quartz +* A place to learn about new features and updates in each version + {{< children >}} diff --git a/content/v2.0/visualize-data/sources.md b/content/v2.0/visualize-data/sources.md index ad2bf09bf..d82d627e1 100644 --- a/content/v2.0/visualize-data/sources.md +++ b/content/v2.0/visualize-data/sources.md @@ -8,116 +8,24 @@ menu: weight: 1 --- - -InfluxDB offers a complete dashboard solution for visualizing your data and monitoring your infrastructure: - -* View [pre-created dashboards](/chronograf/latest/guides/using-precreated-dashboards) from the Host List page. Dashboards are available depending on which Telegraf input plugins you have enabled. These pre-created dashboards cannot be cloned or edited. -* Create custom dashboards from scratch by building queries in the Data Explorer, as described [below](#build-a-dashboard). -* Import dashboard templates when you add or update a connection in Chronograf. See [Dashboard templates](#dashboard-templates) for details. +Like dashboards and buckets, data sources are scoped by organization. When you first access the user interface, you'll be prompted to add a data source. You can also do so anytime using the steps below. -By the end of this guide, you'll be aware of the tools available to you for creating dashboards similar to this example: +**To add data to a bucket**: +1. Click in the **Organizations** icon in the navigation bar. +2. Select the **Buckets** tab. +3. Next to the name of a bucket, click **Add Data**. +4. Select **Streaming**, **Line Protocol**, or **Scraping** from the data source options. +5. Click **Continue**. +6. Follow the prompts add your data source. -![Oh, the Chronobilities](/img/chronograf/v1.7/g-dashboard-possibilities.png) - -## Requirements - -To perform the tasks in this guide, you must have a working Chronograf instance that is connected to an InfluxDB source. -Data is accessed using the Telegraf [system ](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/system) input plugins. -For more information, see [Configuring Chronograf](/chronograf/latest/administration/configuration). - -## Build a Dashboard - -Click **Dashboards** in the navigation bar and then click the **Create Dashboard** button. -A new dashboard is created and ready to begin adding cells. - -### Step 1: Name your dashboard - -Click **Name This Dashboard** and type a new name. In this guide, "ChronoDash" is used. - -### Step 2: Enter cell editor mode - -In the first cell, titled "Untitled Cell", click **Edit** -to open the cell editor mode. - -![Edit your cell](/img/chronograf/g-dashboard-cell-edit.png) - -### Step 3: Create your query - -Click the **Add a Query** button to create an [InfluxQL](/influxdb/latest/query_language/) query. -In query editor mode, use the builder to select from your existing data and allow Chronograf to format the query for you. -Alternatively, manually enter and edit a query. -Chronograf allows you to move seamlessly between using the builder and manually editing the query; when possible, the interface automatically populates the builder with the information from your raw query. - -For our example, the query builder is used to generate a query that shows the average idle CPU usage grouped by host (in this case, there are three hosts). -By default, Chronograf applies the [`MEAN()` function](/influxdb/latest/query_language/functions/#mean) to the data, groups averages into auto-generated time intervals (`:interval:`), and shows data for the past hour (`:dashboardTime:`). -Those defaults are configurable using the query builder or by manually editing the query. - -In addition, the time range (`:dashboardTime:`) is [configurable on the dashboard](#step-6-configure-your-dashboard). - -![Build your query](/img/chronograf/v1.7/g-dashboard-builder.png) - -### Step 4: Choose your visualization type - -Chronograf supports many different [visualization types](/chronograf/latest/guides/visualization-types/). To choose a visualization type, click **Visualization** and select **Step-Plot Graph**. - -![Visualization type](/img/chronograf/v1.7/g-dashboard-visualization.png) - -### Step 5: Save your cell -Click **Save** (the green checkmark icon) to save your cell. - -{{% note %}} -If you navigate away from this page without clicking Save, your work will not be saved. -{{% /note %}} - -### Step 6: Configure your dashboard - -#### Customize cells: -* You can change the name of the cell from "Untitled Cell" by returning to the cell editor mode, clicking on the name, and renaming it. Remember to save your changes. -* **Move** your cell around by clicking its top bar and dragging it around the page -* **Resize** your cell by clicking and dragging its bottom right corner - -#### Explore cell data: -* **Zoom** in on your cell by clicking and dragging your mouse over the area of interest -* **Pan** over your cell data by pressing the shift key and clicking and dragging your mouse over the graph -* **Reset** your cell by double-clicking your mouse in the cell window - -{{% note %}} -These tips only apply to the line, stacked, step-plot, and line+stat [visualization types](/chronograf/latest/guides/visualization-types/). -{{% /note %}} - -#### Configure dashboard-wide settings: -* You can change the dashboard's *auto-refresh interval* at the top of the page - the default interval selected is **Every 15 seconds**. -* You can also modify the dashboard's *time range* at the top of the page - the default range is **Past 15 minutes**. - -Now, you are free to experiment and complete your dashboard by creating, editing, and repositioning more cells! - -## Dashboard templates - -Select from a variety of dashboard templates to import and customize based on which Telegraf plugins you have enabled, such as the following examples: - -* -* -* -* - -**To import dashboard templates:** - -1. From the Configuration page, click **Add Connection** or select an existing connection to edit it. -2. In the **InfluxDB Connection** window, enter or verify your connection details and click **Add** or **Update Connection**. -3. In the **Dashboards** window, select from the available dashboard templates to import based on which Telegraf plugins you have enabled. - - -4. Click **Create (x) Dashboards**. -5. Edit, clone, or configure the dashboards as needed. - - -## Extra Tips - -### Full screen mode -View your dashboard in full screen mode by clicking on the full screen icon in the top right corner of your dashboard. -To exit full screen mode, press the Esc key. - -### Template variables -Dashboards support template variables. -See the [Dashboard Template Variables](/chronograf/latest/guides/dashboard-template-variables/) guide for more information. +**To manage Telegraf configurations**: +1. 1. Click in the **Organizations** icon in the navigation bar. +2. Select the **Telegraf** tab. A list of existing Telegraf configurations appears. +3. To add a new Telegraf configuration: + * Click **Create Configuration** in the upper right. + * Select the Telegraf plugins you want to use to collect data. + * Click **Continue**. + * Follow the instructions on the **Listen for Streaming Data** page that appears to complete your configuration. +4. To delete a Telegraf configuration, hover over its name in the list and click **Delete**. +5. To view details of a Telegraf configuration, hover over its name in the list and click **Download Config**. diff --git a/content/v2.0/visualize-data/visualization-types.md b/content/v2.0/visualize-data/visualization-types.md index 73a0a8c36..3da070369 100644 --- a/content/v2.0/visualize-data/visualization-types.md +++ b/content/v2.0/visualize-data/visualization-types.md @@ -1,7 +1,7 @@ --- title: Visualization types description: > - InfluxDB dashboards support mulitple visualization types including line graphs, + InfluxDB dashboards support multiple visualization types including line graphs, gauges, tables, and more. menu: v2_0: @@ -27,7 +27,6 @@ Each of the available visualization types and available user controls are descri * [Gauge](#gauge) * [Table](#table) -For information on adding and displaying annotations in graph views, see [Adding annotations to Chronograf views](/v1.7/guides/annotations/). ### Graphs diff --git a/static/img/configuration-icon-profile.png b/static/img/configuration-icon-profile.png new file mode 100644 index 000000000..112de0ad2 Binary files /dev/null and b/static/img/configuration-icon-profile.png differ diff --git a/static/img/organizations-icon.png b/static/img/organizations-icon.png new file mode 100644 index 000000000..dcdb8ea12 Binary files /dev/null and b/static/img/organizations-icon.png differ