Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Clarify supported realms when accessing remote monitoring clusters #77938

Merged
merged 6 commits into from
Sep 22, 2020

Conversation

lucabelluccini
Copy link
Contributor

@lucabelluccini lucabelluccini commented Sep 18, 2020

Summary

Clarify supported realms when accessing remote monitoring clusters.
According to #21611, any realm which relies on local Elasticsearch tokens cannot be used to authenticate to a remote monitoring cluster from the Kibana production instance.

Please let me know if we should review any wording or amend the list of supported realms.

For maintainers

  • This should be backported to 6.x, 7.x, 8.x

Preview

https://kibana_77938.docs-preview.app.elstc.co/guide/en/kibana/master/monitoring-data.html

Clarify supported realms when accessing remote monitoring clusters.
According to #21611, any realm which relies on local Elasticsearch tokens cannot be used to authenticate to a remote monitoring cluster from the Kibana production instance.
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-docs (Team:Docs)

@lcawl lcawl added Feature:Stack Monitoring v8.0.0 release_note:skip Skip the PR/issue when compiling release notes labels Sep 18, 2020
@lcawl
Copy link
Contributor

lcawl commented Sep 18, 2020

I think some clarification is required about which data collection methods this limitation applies to. Also whether the use of a separate Kibana instance for the monitoring cluster ameliorates the issue (as suggested in #21611 (comment)). Once those details are known, we should also add info to this main monitoring page: https://www.elastic.co/guide/en/elasticsearch/reference/master/monitoring-overview.html

Copy link
Contributor

@chrisronline chrisronline left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for catching this, @lucabelluccini

Copy link
Member

@azasypkin azasypkin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks! Just left one note.

@@ -13,6 +13,15 @@ At a minimum, you must have monitoring data for the {es} production cluster.
Once that data exists, {kib} can display monitoring data for other products in
the cluster.

TIP: If you use a separate monitoring cluster to store the monitoring data, it
is strongly recommended that you use a separate {kib} instance to view it. If
you use SAML, Kerberos, PKI, or OpenID Connect realms on your production or
Copy link
Member

@azasypkin azasypkin Sep 22, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note: Sorry for not mentioning it earlier, but I think we also want to mention that users will also have to use a dedicated {kib} instance if Kibana is configured to use Token authentication provider (it may rely on {es} Native, Reserved, LDAP, AD or any other custom password-based realm under the hood). This provider isn't widely used right now, but it's the only option if users want to authenticate with LDAP/AD where OTP is a requirement and we eventually want to make it a default provider instead of Basic as well.

Something similar to this, but feel free to rephrase:

Suggested change
you use SAML, Kerberos, PKI, or OpenID Connect realms on your production or
you log in to {kib} using SAML, Kerberos, PKI, OpenID Connect, or Token authentication provider on your production or

Some context around "realm" vs "authentication provider" since it may be a bit confusing: Elasticsearch's "realms" map 1-to-1 to Kibana's "authentication providers" most of the time, but not always (e.g. Token and Basic providers can rely on either native, or LDAP, or AD ES realms). That's the main reason why we didn't use term "realms" in Kibana.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the information! I've added the suggested text.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants