From a2233d7aba54a3541eb55ec90fbf3c6f41137b58 Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Wed, 23 Jan 2019 11:36:40 -0700 Subject: [PATCH] added all cli content for org, member, and bucket management --- content/v2.0/organizations/buckets/_index.md | 3 ++- .../organizations/buckets/create-bucket.md | 1 + .../organizations/buckets/delete-bucket.md | 2 +- .../organizations/buckets/update-bucket.md | 24 ++++++++++++++++++- .../organizations/buckets/view-buckets.md | 12 +++++++++- content/v2.0/organizations/create-org.md | 13 +++++++++- content/v2.0/organizations/delete-org.md | 13 +++++++++- content/v2.0/organizations/members/_index.md | 3 ++- .../v2.0/organizations/members/add-member.md | 4 ++++ .../organizations/members/remove-member.md | 4 ++++ .../organizations/members/view-members.md | 13 +++++++++- content/v2.0/organizations/update-org.md | 14 ++++++++++- content/v2.0/organizations/view-orgs.md | 11 ++++++++- .../process-data/manage-tasks/view-tasks.md | 2 +- 14 files changed, 108 insertions(+), 11 deletions(-) diff --git a/content/v2.0/organizations/buckets/_index.md b/content/v2.0/organizations/buckets/_index.md index 25e5fa2c2..5b6e18ce0 100644 --- a/content/v2.0/organizations/buckets/_index.md +++ b/content/v2.0/organizations/buckets/_index.md @@ -1,5 +1,6 @@ --- -title: Manage buckets in InfluxDB +title: Manage buckets +seotitle: Manage buckets in InfluxDB description: > How to manage buckets in InfluxDB. A bucket is a named location where time series data is stored with a retention policy. diff --git a/content/v2.0/organizations/buckets/create-bucket.md b/content/v2.0/organizations/buckets/create-bucket.md index 7c6edcdbb..38b1b1a28 100644 --- a/content/v2.0/organizations/buckets/create-bucket.md +++ b/content/v2.0/organizations/buckets/create-bucket.md @@ -28,6 +28,7 @@ to create a bucket. 5. Click **Create** to create the bucket. ## Create a bucket using 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: diff --git a/content/v2.0/organizations/buckets/delete-bucket.md b/content/v2.0/organizations/buckets/delete-bucket.md index e324a4e42..d67fa359b 100644 --- a/content/v2.0/organizations/buckets/delete-bucket.md +++ b/content/v2.0/organizations/buckets/delete-bucket.md @@ -25,7 +25,7 @@ to delete a 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: +to delete a bucket. Deleting a bucket requires the following: - The bucket ID _(provided in the output of `influx bucket find`)_. diff --git a/content/v2.0/organizations/buckets/update-bucket.md b/content/v2.0/organizations/buckets/update-bucket.md index f199645a2..3297c932b 100644 --- a/content/v2.0/organizations/buckets/update-bucket.md +++ b/content/v2.0/organizations/buckets/update-bucket.md @@ -24,4 +24,26 @@ _Complete content coming soon_ ## Update a bucket using the influx CLI -_Complete content coming soon_ +Use the 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 index a559f9971..1b8929f30 100644 --- a/content/v2.0/organizations/buckets/view-buckets.md +++ b/content/v2.0/organizations/buckets/view-buckets.md @@ -21,4 +21,14 @@ _Complete content coming soon_ ## View buckets using the influx CLI -_Complete content coming soon_ +Use the 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 index 3b0517c3d..b25adb1fd 100644 --- a/content/v2.0/organizations/create-org.md +++ b/content/v2.0/organizations/create-org.md @@ -22,4 +22,15 @@ _Complete content coming soon_ ## Create an organization using the influx CLI -_Complete content coming soon_ +Use the 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 index 5ac462dca..23cdf78c0 100644 --- a/content/v2.0/organizations/delete-org.md +++ b/content/v2.0/organizations/delete-org.md @@ -22,4 +22,15 @@ _Complete content coming soon_ ## Delete an organization using the influx CLI -_Complete content coming soon_ +Use the the [`influx org delete` command](/v2.0/reference/cli/influx/org/delete) +to delete an organization. Deleting a 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 index 328771023..818f77b3b 100644 --- a/content/v2.0/organizations/members/_index.md +++ b/content/v2.0/organizations/members/_index.md @@ -1,5 +1,6 @@ --- -title: Manage members of an organization in InfluxDB +title: Manage members of an organization +seotitle: Manage members of an organization in InfluxDB description: placeholder menu: v2_0: diff --git a/content/v2.0/organizations/members/add-member.md b/content/v2.0/organizations/members/add-member.md index 771f18ec5..0b60e50fe 100644 --- a/content/v2.0/organizations/members/add-member.md +++ b/content/v2.0/organizations/members/add-member.md @@ -7,6 +7,7 @@ menu: name: Add a member parent: Manage members weight: 1 +draft: true --- Use the InfluxDB user interface (UI) or the `influx` command line interface (CLI) @@ -24,4 +25,7 @@ _Complete content coming soon_ ## Add a member to an organization using the influx CLI +Use the 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 index a2d6ff15d..9e48d1372 100644 --- a/content/v2.0/organizations/members/remove-member.md +++ b/content/v2.0/organizations/members/remove-member.md @@ -7,6 +7,7 @@ menu: name: Remove a member parent: Manage members weight: 3 +draft: true --- Use the InfluxDB user interface (UI) or the `influx` command line interface (CLI) @@ -24,4 +25,7 @@ _Complete content coming soon_ ## Remove a member from an organization using the influx CLI +Use the 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 index 64a80110d..62588f04f 100644 --- a/content/v2.0/organizations/members/view-members.md +++ b/content/v2.0/organizations/members/view-members.md @@ -24,4 +24,15 @@ _Complete content coming soon_ ## View members of organization using the influx CLI -_Complete content coming soon_ +Use the 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 index 164fbae25..0da7cdf58 100644 --- a/content/v2.0/organizations/update-org.md +++ b/content/v2.0/organizations/update-org.md @@ -22,4 +22,16 @@ _Complete content coming soon_ ## Update an organization using the influx CLI -_Complete content coming soon_ +Use the the [`influx org update` command](/v2.0/reference/cli/influx/org/update) +to update an organization. Updating a 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 index 042174557..0b1aafc15 100644 --- a/content/v2.0/organizations/view-orgs.md +++ b/content/v2.0/organizations/view-orgs.md @@ -22,4 +22,13 @@ _Complete content coming soon_ ## View organizations using the influx CLI -_Complete content coming soon_ +Use the 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 1417dd19b..2a0a84f69 100644 --- a/content/v2.0/process-data/manage-tasks/view-tasks.md +++ b/content/v2.0/process-data/manage-tasks/view-tasks.md @@ -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.