diff --git a/docs/security/authorization/index.asciidoc b/docs/security/authorization/index.asciidoc index 6fc0f3f1367da..d33d6297536fb 100644 --- a/docs/security/authorization/index.asciidoc +++ b/docs/security/authorization/index.asciidoc @@ -13,6 +13,7 @@ NOTE: When running multiple tenants of Kibana by changing the `kibana.index` in To create a role that grants {kib} privileges, go to **Management -> Security -> Roles** and click **Create role**. +[[adding_kibana_privileges]] ==== Adding {kib} privileges To assign {kib} privileges to the role, click **Add space privilege** in the Kibana section. diff --git a/docs/spaces/images/delete-space.png b/docs/spaces/images/delete-space.png deleted file mode 100644 index ce83670ad2a3a..0000000000000 Binary files a/docs/spaces/images/delete-space.png and /dev/null differ diff --git a/docs/spaces/images/spaces-roles.png b/docs/spaces/images/spaces-roles.png new file mode 100755 index 0000000000000..2ecbfed6017c4 Binary files /dev/null and b/docs/spaces/images/spaces-roles.png differ diff --git a/docs/spaces/index.asciidoc b/docs/spaces/index.asciidoc index c6bf9a9184a66..fdd564cc69c9f 100644 --- a/docs/spaces/index.asciidoc +++ b/docs/spaces/index.asciidoc @@ -2,28 +2,119 @@ [[xpack-spaces]] == Spaces -With spaces, you can organize your dashboards and other saved objects into meaningful categories. -After creating your own spaces, you will be asked to choose a space when you enter Kibana. -Once inside a space, you will only see the dashboards and other saved objects that belong to that space. +Spaces enable you to organize your dashboards and other saved +objects into meaningful categories. Once inside a space, you see only +the dashboards and saved objects that belong to that space. -You can change your current space at any time, by clicking on the space avatar in the top left. +{kib} creates a default space for you. +After you create your own +spaces, you're asked to choose a space when you log in to Kibana. You can change your +current space at any time by using the menu in the upper left. [role="screenshot"] image::spaces/images/change-space.png["Change current space"] -With security enabled, you can <>. +Kibana supports spaces in several ways. You can: +[[spaces-getting-started]] + +* <> +* <> +* <> +* <> +* <> [float] -[[spaces-getting-started]] -=== Getting Started +[[spaces-managing]] +=== View, create, and delete spaces + +Go to **Management > Spaces** for an overview of your spaces. This view provides actions +for you to create, edit, and delete spaces. + +[role="screenshot"] +image::spaces/images/space-management.png["Space management"] + +[float] +==== Create or edit a space + +You can create as many spaces as you like. Click *Create a space* and provide a name, +URL identifier, optional description. + +The URL identifier is a short text string that becomes part of the +{kib} URL when you are inside that space. {kib} suggests a URL identifier based +on the name of your space, but you can customize the identifier to your liking. +You cannot change the space identifier once you create the space. + +{kib} also has an <> +if you prefer to create spaces programatically. + +[role="screenshot"] +image::spaces/images/edit-space.png["Space management"] + +[float] +==== Delete a space + +Deleting a space permanently removes the space and all of its contents. +Find the space on the *Spaces* overview page and click the trash icon in the Actions column. +You can't delete the default space, but you can customize it to your liking. + +[float] +[[spaces-control-feature-visibility]] +=== Control feature access based on user needs + +You have control over which features are visible in each space. +For example, you might hide Dev Tools +in your "Executive" space or show Stack Monitoring only in your "Admin" space. +You can define which features to show or hide when you add or edit a space. + +Controlling feature +visibility is not a security feature. To secure access +to specific features on a per-user basis, you must configure +<>. + +[role="screenshot"] +image::spaces/images/edit-space-feature-visibility.png["Controlling features visiblity"] + +[float] +[[spaces-control-user-access]] +=== Control feature access based on user privileges + +When using Kibana with security, you can configure applications and features +based on your users’ privileges. This means different roles can have access +to different features in the same space. +Power users might have privileges to create and edit visualizations and dashboards, +while analysts or executives might have Dashboard and Canvas with read-only privileges. +See <> for details. + +[role="screenshot"] +image::spaces/images/spaces-roles.png["Controlling features visiblity"] + +[float] +[[spaces-moving-objects]] +=== Move saved objects between spaces +Use {kib}'s <> +interface to copy objects from one space to another. + +. Navigate to the space that contains your saved objects. +. Export your saved objects via the import/export interface. +. Navigate to the space where you want to import the objects. +. Import your saved objects via the import/export interface. +. (Optional) Delete objects in the export space that you no longer need. + +{kib} also has experimental <> and +<> dashboard APIs if you want +a dashboard-centric way to automate this process. + + +[float] +[[spaces-delete-started]] +=== Disable and version updates -Spaces are automatically enabled in {kib}. If you don't wish to use this feature, you can disable it -by setting `xpack.spaces.enabled` to `false` in your `kibana.yml` configuration file. +Spaces are automatically enabled in {kib}. If you don't want use this feature, +you can disable it +by setting `xpack.spaces.enabled` to `false` in your +`kibana.yml` configuration file. -{kib} automatically creates a default space for you. If you are upgrading from another -version of {kib}, then the default space will contain all of your existing saved objects. -Although you can't delete the default space, you can customize it to your liking. +If you are upgrading your +version of {kib}, the default space will contain all of your existing saved objects. -include::managing-spaces.asciidoc[] -include::moving-saved-objects.asciidoc[] diff --git a/docs/spaces/managing-spaces.asciidoc b/docs/spaces/managing-spaces.asciidoc deleted file mode 100644 index fbfed15bc6ee9..0000000000000 --- a/docs/spaces/managing-spaces.asciidoc +++ /dev/null @@ -1,34 +0,0 @@ -[role="xpack"] -[[spaces-managing]] -=== Managing spaces -You can manage spaces from the **Management > Spaces** page. Here you can create, edit, and delete your spaces. - -[NOTE] -{kib} has an <> if you want to create your spaces programatically. - -[role="screenshot"] -image::spaces/images/space-management.png["Space Management"] - -==== Creating and updating spaces -You can create as many spaces as you like, but each space must have a unique space identifier. The space identifier is a short string of text that is part of the {kib} URL when you are inside that space. {kib} automatically suggests a space identifier based on the name of your space, but you are free to customize this to your liking. - -[NOTE] -You cannot change the space identifier once the space is created. - -[role="screenshot"] -image::spaces/images/edit-space.png["Updating a space"] - -==== Controlling feature visibility -You can control which {kib} features are visible in each space. For example, you can hide “Dev Tools” in your “Executive” space, if users of that space don’t need this feature. - -[role="screenshot"] -image::spaces/images/edit-space-feature-visibility.png["Controlling features visiblity"] - - -NOTE: This is not considered a security feature. If you wish to secure access to specific features on a per-user basis, then you need to configure <>. - -==== Deleting spaces -Deleting a space is a destructive operation, which cannot be undone. When you delete a space, all of the saved objects that belong to that space are also deleted. - -[role="screenshot"] -image::spaces/images/delete-space.png["Deleting a space"] diff --git a/docs/spaces/moving-saved-objects.asciidoc b/docs/spaces/moving-saved-objects.asciidoc deleted file mode 100644 index e6a116f54a252..0000000000000 --- a/docs/spaces/moving-saved-objects.asciidoc +++ /dev/null @@ -1,14 +0,0 @@ -[role="xpack"] -[[spaces-moving-objects]] -=== Moving saved objects between spaces -You can use {kib}'s <> interface to copy objects from one space to another: - -1. Navigate to the space that contains your saved objects. -2. Export your saved objects via the <> interface. -3. Navigate to the space you are importing to. -4. Import your saved objects via the <> interface. -5. (optional) Delete the saved objects from the space you exported from, if you don't want to keep a copy there. - - -[NOTE] -{kib} also has experimental <> and <> dashboard APIs if you are looking for a dashboard-centric way to automate this process. \ No newline at end of file