Skip to content

Commit

Permalink
Merge branch 'master' into small_cases_bugs
Browse files Browse the repository at this point in the history
  • Loading branch information
kibanamachine authored Apr 8, 2021
2 parents 7ed2c3c + 128ed7f commit a3e60d0
Showing 28 changed files with 385 additions and 221 deletions.
4 changes: 3 additions & 1 deletion docs/getting-started/quick-start-guide.asciidoc
Original file line number Diff line number Diff line change
@@ -12,7 +12,7 @@ When you've finished, you'll know how to:
[float]
=== Required privileges
When security is enabled, you must have `read`, `write`, and `manage` privileges on the `kibana_sample_data_*` indices.
For more information, refer to {ref}/security-privileges.html[Security privileges].
Learn how to <<tutorial-secure-access-to-kibana, secure access to {kib}>>, or refer to {ref}/security-privileges.html[Security privileges] for more information.

[float]
[[set-up-on-cloud]]
@@ -141,3 +141,5 @@ For more information, refer to <<dashboard,Dashboard>>.
If you are you ready to add your own data, refer to <<connect-to-elasticsearch,Add data to {kib}>>.

If you want to ingest your data, refer to {fleet-guide}/fleet-quick-start.html[Quick start: Get logs and metrics into the Elastic Stack].

If you want to secure access to your data, refer to our guide on <<tutorial-secure-access-to-kibana, securing {kib}>>
6 changes: 6 additions & 0 deletions docs/redirects.asciidoc
Original file line number Diff line number Diff line change
@@ -286,3 +286,9 @@ This content has moved. See {ref}/ingest.html[Ingest pipelines].
== Timelion

This content has moved. refer to <<timelion>>.


[role="exclude",id="space-rbac-tutorial"]
== Tutorial: Use role-based access control to customize Kibana spaces

This content has moved. refer to <<tutorial-secure-access-to-kibana>>.
Binary file not shown.
Binary file removed docs/user/security/images/role-management.png
Binary file not shown.
Binary file removed docs/user/security/images/role-new-user.png
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion docs/user/security/index.asciidoc
Original file line number Diff line number Diff line change
@@ -47,4 +47,3 @@ include::authorization/kibana-privileges.asciidoc[]
include::api-keys/index.asciidoc[]
include::encryption-keys/index.asciidoc[]
include::role-mappings/index.asciidoc[]
include::rbac_tutorial.asciidoc[]
105 changes: 0 additions & 105 deletions docs/user/security/rbac_tutorial.asciidoc

This file was deleted.

136 changes: 136 additions & 0 deletions docs/user/security/tutorials/how-to-secure-access-to-kibana.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,136 @@
[[tutorial-secure-access-to-kibana]]
== Securing access to {kib}


{kib} is home to an ever-growing suite of powerful features, which help you get the most out of your data. Your data is important, and should be protected. {kib} allows you to secure access to your data and control how users are able to interact with your data.

For example, some users might only need to view your stunning dashboards, while others might need to manage your fleet of Elastic agents and run machine learning jobs to detect anomalous behavior in your network.

This guide introduces you to three of {kib}'s security features: spaces, roles, and users. By the end of this tutorial, you will learn how to manage these entities, and how you can leverage them to secure access to both {kib} and your data.

[float]
=== Spaces

Do you have multiple teams using {kib}? Do you want a “playground” to experiment with new visualizations or alerts? If so, then <<xpack-spaces,{kib} Spaces>> can help.

Think of a space as another instance of {kib}. A space allows you to organize your <<dashboard, dashboards>>, <<alerting-getting-started, alerts>>, <<xpack-ml, machine learning jobs>>, and much more into their own categories. For example, you might have a Marketing space for your marketeers to track the results of their campaigns, and an Engineering space for your developers to {apm-get-started-ref}/overview.html[monitor application performance].

The assets you create in one space are isolated from other spaces, so when you enter a space, you only see the assets that belong to that space.

Refer to the <<xpack-spaces, Spaces documentation>> for more information.

[float]
=== Roles

Once your spaces are setup, the next step to securing access is to provision your roles. Roles are a collection of privileges that allow you to perform actions in {kib} and Elasticsearch. Roles are assigned to users, and to {ref}/built-in-users.html[system accounts] that power the Elastic Stack.

You can create your own roles, or use any of the {ref}/built-in-roles.html[built-in roles]. Some built-in roles are intended for Elastic Stack components and should not be assigned to end users directly.

One of the more useful built-in roles is `kibana_admin`. Assigning this role to your users will grant access to all of {kib}'s features. This includes the ability to manage Spaces.

The built-in roles are great for getting started with the Elastic Stack, and for system administrators who do not need more restrictive access. With so many features, it’s not possible to ship more granular roles to accommodate everyone’s needs. This is where custom roles come in.

As an administrator, you have the ability to create your own roles to describe exactly the kind of access your users should have. For example, you might create a `marketing_user` role, which you then assign to all users in your marketing department. This role would grant access to all of the necessary data and features for this team to be successful, without granting them access they don’t require.


[float]
=== Users

Once your roles are setup, the next step to securing access is to create your users, and assign them one or more roles. {kib}'s user management allows you to provision accounts for each of your users.

TIP: Want Single Sign-on? {kib} supports a wide range of SSO implementations, including SAML, OIDC, LDAP/AD, and Kerberos. <<kibana-authentication, Learn more about {kib}'s SSO features>>.


[float]
[[tutorial-secure-kibana-dashboards-only]]
=== Example: Create a user with access only to dashboards

Let’s work through an example together. Consider a marketing analyst who wants to monitor the effectiveness of their campaigns. They should be able to see their team’s dashboards, but not be allowed to view or manage anything else in {kib}. All of the team’s dashboards are located in the Marketing space.

[float]
==== Create a space

Create a Marketing space for your marketing analysts to use.

. Open the main menu, and select **Stack Management**.
. Under **{kib}**, select **Spaces**.
. Click **Create a space**.
. Give this space a unique name. For example: `Marketing`.
. Click **Create space**.
+
If you’ve followed the example above, you should end up with a space that looks like this:
+
[role="screenshot"]
image::user/security/images/tutorial-secure-access-example-1-space.png[Create space UI]


[float]
==== Create a role

To effectively use dashboards, create a role that describes the privileges you want to grant.
In this example, a marketing analyst will need:

* Access to **read** the data that powers the dashboards
* Access to **read** the dashboards within the `Marketing` space

To create the role:

. Open the main menu, and select **Stack Management**.
. Under **Security**, select **Roles**.
. Click **Create role**.
. Give this role a unique name. For example: `marketing_dashboards_role`.
. For this example, you want to store all marketing data in the `acme-marketing-*` set of indices. To grant this access, locate the **Index privileges** section and enter:
.. `acme-marketing-*` in the **Indices** field.
.. `read` and `view_index_metadata` in the **Privileges** field.
+
TIP: You can add multiple patterns of indices, and grant different access levels to each. Click **Add index privilege** to grant additional access.
. To grant access to dashboards in the `Marketing` space, locate the {kib} section, and click **Add {kib} privilege**:
.. From the **Spaces** dropdown, select the `Marketing` space.
.. Expand the **Analytics** section, and select the **Read** privilege for **Dashboard**.
.. Click **Add Kibana privilege**.
. Click **Create role**.
+
If you’ve followed the example above, you should end up with a role that looks like this:
+
[role="screenshot"]
image::user/security/images/tutorial-secure-access-example-1-role.png[Create role UI]


[float]
==== Create a user

Now that you created a role, create a user account.

. Navigate to *Stack Management*, and under *Security*, select *Users*.
. Click *Create user*.
. Give this user a descriptive username, and choose a secure password.
. Assign the *marketing_dashboards_role* that you previously created to this new user.
. Click *Create user*.

[role="screenshot"]
image::user/security/images/tutorial-secure-access-example-1-user.png[Create user UI]

[float]
==== Verify

Verify that the user and role are working correctly.

. Logout of {kib} if you are already logged in.
. In the login screen, enter the username and password for the account you created.
+
You’re taken into the `Marketing` space, and the main navigation shows only the *Dashboard* application.
+
[role="screenshot"]
image::user/security/images/tutorial-secure-access-example-1-test.png[Verifying access to dashboards]


[float]
=== What's next?

This guide is an introduction to {kib}'s security features. Check out these additional resources to learn more about authenticating and authorizing your users.

* View the <<kibana-authentication, authentication guide>> to learn more about single-sign on and other login features.

* View the <<xpack-kibana-role-management, authorization guide>> to learn more about authorizing access to {kib}'s features.

Still have questions? Ask on our https://discuss.elastic.co/c/kibana[Kibana discuss forum] and a fellow community member or Elastic engineer will help out.
2 changes: 2 additions & 0 deletions docs/user/setup.asciidoc
Original file line number Diff line number Diff line change
@@ -54,6 +54,8 @@ include::{kib-repo-dir}/setup/start-stop.asciidoc[]

include::{kib-repo-dir}/setup/access.asciidoc[]

include::security/tutorials/how-to-secure-access-to-kibana.asciidoc[]

include::{kib-repo-dir}/setup/connect-to-elasticsearch.asciidoc[]

include::{kib-repo-dir}/setup/upgrade.asciidoc[]
45 changes: 0 additions & 45 deletions x-pack/plugins/infra/server/kibana.index.ts

This file was deleted.

Original file line number Diff line number Diff line change
@@ -33,15 +33,25 @@ type ConditionResult = InventoryMetricConditions & {
isError: boolean;
};

export const evaluateCondition = async (
condition: InventoryMetricConditions,
nodeType: InventoryItemType,
source: InfraSource,
logQueryFields: LogQueryFields,
esClient: ElasticsearchClient,
filterQuery?: string,
lookbackSize?: number
): Promise<Record<string, ConditionResult>> => {
export const evaluateCondition = async ({
condition,
nodeType,
source,
logQueryFields,
esClient,
compositeSize,
filterQuery,
lookbackSize,
}: {
condition: InventoryMetricConditions;
nodeType: InventoryItemType;
source: InfraSource;
logQueryFields: LogQueryFields;
esClient: ElasticsearchClient;
compositeSize: number;
filterQuery?: string;
lookbackSize?: number;
}): Promise<Record<string, ConditionResult>> => {
const { comparator, warningComparator, metric, customMetric } = condition;
let { threshold, warningThreshold } = condition;

@@ -61,6 +71,7 @@ export const evaluateCondition = async (
timerange,
source,
logQueryFields,
compositeSize,
filterQuery,
customMetric
);
@@ -105,6 +116,7 @@ const getData = async (
timerange: InfraTimerangeInput,
source: InfraSource,
logQueryFields: LogQueryFields,
compositeSize: number,
filterQuery?: string,
customMetric?: SnapshotCustomMetricInput
) => {
@@ -128,7 +140,13 @@ const getData = async (
includeTimeseries: Boolean(timerange.lookbackSize),
};
try {
const { nodes } = await getNodes(client, snapshotRequest, source, logQueryFields);
const { nodes } = await getNodes(
client,
snapshotRequest,
source,
logQueryFields,
compositeSize
);

if (!nodes.length) return { [UNGROUPED_FACTORY_KEY]: null }; // No Data state

Loading

0 comments on commit a3e60d0

Please sign in to comment.