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

Add documentation on Kerberos configuration #7844

Merged
merged 13 commits into from
Jul 30, 2024

Conversation

spapadop
Copy link
Contributor

Description

Kerberos is currently supported on OpenSearch as authentication backend, but it is not documented.

Issues Resolved

Close #7295

Version

all

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Copy link

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

spapadop and others added 2 commits July 26, 2024 17:37
Signed-off-by: Sokratis Papadopoulos <[email protected]>
@spapadop spapadop force-pushed the security/kerberos branch from 9dcb98e to d51b6ad Compare July 26, 2024 15:37
Sokratis Papadopoulos added 5 commits July 26, 2024 17:37
Signed-off-by: Sokratis Papadopoulos <[email protected]>
Signed-off-by: Sokratis Papadopoulos <[email protected]>
Signed-off-by: Sokratis Papadopoulos <[email protected]>
Signed-off-by: Sokratis Papadopoulos <[email protected]>
Signed-off-by: Sokratis Papadopoulos <[email protected]>
@spapadop spapadop marked this pull request as ready for review July 26, 2024 15:48
Signed-off-by: Sokratis Papadopoulos <[email protected]>
@spapadop
Copy link
Contributor Author

@hdhalter ready :)

@kkhatua kkhatua requested a review from derek-ho July 26, 2024 19:23
@hdhalter hdhalter added 3 - Tech review PR: Tech review in progress backport 2.15 labels Jul 26, 2024
@hdhalter hdhalter assigned derek-ho and unassigned hdhalter Jul 26, 2024
Copy link
Contributor

@derek-ho derek-ho left a comment

Choose a reason for hiding this comment

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

Changes look good to me. @cwperks maybe can provide another set of eyes here. It seems like this is mostly moving commented out docs out.

@@ -162,65 +163,4 @@ To learn about configuring the authentication backends, see the [Authentication
* [Active Directory and LDAP]({{site.url}}{{site.baseurl}}/security/authentication-backends/ldap/)
* [Proxy-based authentication]({{site.url}}{{site.baseurl}}/security/authentication-backends/proxy/)
* [Client certificate authentication]({{site.url}}{{site.baseurl}}/security/authentication-backends/client-auth/)


<!--- Remvoving Kerberos documentation until issue #907 is resolved.
Copy link
Member

Choose a reason for hiding this comment

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

I see that opensearch-project/security-dashboards-plugin#907 is still open. While we don't have automated functional tests in the security-dashboards-plugin to verify kerberos, has it been validated through a demo configuration?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I assume that kerberos is still not supported on OpenSearch Dashboards, but this documentation is rather about OpenSearch, where kerberos is supported. We've been using it successfully on all our clusters already from the OpenDistro era.

Signed-off-by: Sokratis Papadopoulos <[email protected]>
@Naarcha-AWS Naarcha-AWS added 4 - Doc review PR: Doc review in progress and removed 3 - Tech review PR: Tech review in progress labels Jul 29, 2024
@Naarcha-AWS Naarcha-AWS self-assigned this Jul 29, 2024
@spapadop
Copy link
Contributor Author

@Naarcha-AWS thanks for the commit, changes seem good! But the DCO check if failing ever since, could you please sign accordingly?

@Naarcha-AWS Naarcha-AWS merged commit 4388aa0 into opensearch-project:main Jul 30, 2024
5 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jul 30, 2024
* Add documentation on Kerberos configuration.

Signed-off-by: Sokratis Papadopoulos <[email protected]>

* Add krb doc

Signed-off-by: Sokratis Papadopoulos <[email protected]>

* Reorder kerberos in backend list

Signed-off-by: Sokratis Papadopoulos <[email protected]>

* Reformat

Signed-off-by: Sokratis Papadopoulos <[email protected]>

* Typo on acceptor_principal

Signed-off-by: Sokratis Papadopoulos <[email protected]>

* Fix style

Signed-off-by: Sokratis Papadopoulos <[email protected]>

* Fix style

Signed-off-by: Sokratis Papadopoulos <[email protected]>

* Typo on acceptor_principal

Signed-off-by: Sokratis Papadopoulos <[email protected]>

* Add default value for boolean params

Signed-off-by: Sokratis Papadopoulos <[email protected]>

* Update kerberos.md

---------

Signed-off-by: Sokratis Papadopoulos <[email protected]>
Co-authored-by: Sokratis Papadopoulos <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
(cherry picked from commit 4388aa0)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@spapadop spapadop deleted the security/kerberos branch July 30, 2024 16:50
mingshl pushed a commit to mingshl/documentation-website that referenced this pull request Aug 2, 2024
* Add documentation on Kerberos configuration.

Signed-off-by: Sokratis Papadopoulos <[email protected]>

* Add krb doc

Signed-off-by: Sokratis Papadopoulos <[email protected]>

* Reorder kerberos in backend list

Signed-off-by: Sokratis Papadopoulos <[email protected]>

* Reformat

Signed-off-by: Sokratis Papadopoulos <[email protected]>

* Typo on acceptor_principal

Signed-off-by: Sokratis Papadopoulos <[email protected]>

* Fix style

Signed-off-by: Sokratis Papadopoulos <[email protected]>

* Fix style

Signed-off-by: Sokratis Papadopoulos <[email protected]>

* Typo on acceptor_principal

Signed-off-by: Sokratis Papadopoulos <[email protected]>

* Add default value for boolean params

Signed-off-by: Sokratis Papadopoulos <[email protected]>

* Update kerberos.md

---------

Signed-off-by: Sokratis Papadopoulos <[email protected]>
Co-authored-by: Sokratis Papadopoulos <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
4 - Doc review PR: Doc review in progress backport 2.15
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Add information regarding Kerberos integration
5 participants