diff --git a/docs/management/images/tags/bulk-assign-selection.png b/docs/management/images/tags/bulk-assign-selection.png new file mode 100644 index 000000000000..1c8687226b51 Binary files /dev/null and b/docs/management/images/tags/bulk-assign-selection.png differ diff --git a/docs/management/images/tags/create-tag.png b/docs/management/images/tags/create-tag.png new file mode 100644 index 000000000000..a88e754457b9 Binary files /dev/null and b/docs/management/images/tags/create-tag.png differ diff --git a/docs/management/images/tags/manage-assignments-flyout.png b/docs/management/images/tags/manage-assignments-flyout.png new file mode 100644 index 000000000000..a4e0b7a49d96 Binary files /dev/null and b/docs/management/images/tags/manage-assignments-flyout.png differ diff --git a/docs/management/images/tags/tag-management-section.png b/docs/management/images/tags/tag-management-section.png new file mode 100644 index 000000000000..4aae3ea06782 Binary files /dev/null and b/docs/management/images/tags/tag-management-section.png differ diff --git a/docs/management/managing-tags.asciidoc b/docs/management/managing-tags.asciidoc new file mode 100644 index 000000000000..3da98b2281fd --- /dev/null +++ b/docs/management/managing-tags.asciidoc @@ -0,0 +1,75 @@ +[role="xpack"] +[[managing-tags]] +== Tags + +Tags enable you to categorize your saved objects. You can then easily filter for related objects based on shared tags. + +To begin, open the main menu, click *Stack Management*, then click *Tags*. + +[role="screenshot"] +image::images/tags/tag-management-section.png[Tags management section] + +[float] +=== Required permissions + +Access to *Tags* requires the `Tag Management` {kib} privilege. To add the privilege, open the menu, +click *Stack Management*, then click *Roles*. + +In addition: + +* The `read` privilege allows you to assign tags to the saved objects for which you have write permission. +* The `write` privilege enables you to create, edit, and delete tags. + + +NOTE: Having the `Tag Management` {kib} privilege is not required to +view tags assigned on objects the user has `read` access to, or to filter objects by tags +in {kib} applications or from the navigational search. + +[float] +[[settings-create-tag]] +=== Create a tag + +Create a tag to assign to your saved objects. + +. Click *Create tag*. ++ +[role="screenshot"] +image::images/tags/create-tag.png[Tag creation popin] +. Enter a name and select a color for the new tag. ++ +The name can include alphanumeric characters (English letters and digits), `:`, `-`, `_` and the space character, +and cannot be longer than 50 characters. +. Click *Create tag*. + +[float] +[[settings-assign-tag]] +=== Assign a tag to saved objects + +Assign or remove tags to one or more saved objects. You must have `write` permission +on the objects to which you assign the tags. + +. Click the action (...) icon in the tag row, and then select the *Manage assignments* action. ++ +[role="screenshot"] +image::images/tags/manage-assignments-flyout.png[Assign flyout] +. Select the objects to which you want to assign or remove tags. +. Click on *Save tag assignments*. + +TIP: To assign multiple tags to objects at once, select their checkboxes +and then select *Manage tag assignments* from the *selected tags* menu. + +[role="screenshot"] +image::images/tags/bulk-assign-selection.png[Bulk assign tags] + +[float] +[[settings-delete-tag]] +=== Delete a tag + +Delete a tag and remove it from any saved objects. + +. Click the action (...) icon in the tag row, and then select the *Delete* action. + +. Click *Delete tag*. + +TIP: To delete multiple tags at once, select their checkboxes in the list view, +and then select *Delete* action from the *selected tags* menu. \ No newline at end of file diff --git a/docs/user/management.asciidoc b/docs/user/management.asciidoc index 8933bf64d273..9d2b0ae593b3 100644 --- a/docs/user/management.asciidoc +++ b/docs/user/management.asciidoc @@ -139,6 +139,9 @@ a| <> | Copy, edit, delete, import, and export your saved objects. These include dashboards, visualizations, maps, index patterns, Canvas workpads, and more. +| <> +|Create, manage, and assign tags to your saved objects. + | <> | Create spaces to organize your dashboards and other saved objects into categories. A space is isolated from all other spaces, @@ -196,6 +199,8 @@ include::{kib-repo-dir}/management/rollups/create_and_manage_rollups.asciidoc[] include::{kib-repo-dir}/management/managing-saved-objects.asciidoc[] +include::{kib-repo-dir}/management/managing-tags.asciidoc[] + include::security/index.asciidoc[] include::{kib-repo-dir}/management/snapshot-restore/index.asciidoc[]