-
Notifications
You must be signed in to change notification settings - Fork 65
HDDS-14658. [Docs] Show all available versions in the drop-down menu and defaults to Next. #350
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
Open
jojochuang
wants to merge
4
commits into
apache:master
Choose a base branch
from
jojochuang:HDDS-14658
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,35 @@ | ||
| --- | ||
| title: Kerberos Authentication | ||
| sidebar_label: Kerberos | ||
| --- | ||
|
|
||
| # Authentication with Kerberos | ||
| ## Kerberos Authentication in Apache Ozone | ||
|
|
||
| **TODO:** File a subtask under [HDDS-9857](https://issues.apache.org/jira/browse/HDDS-9857) and complete this page or section. | ||
| This document explains the fundamentals of Kerberos authentication and its application within Apache Ozone to secure communication between clients and services, as well as between Ozone services internally. | ||
|
|
||
| ## Using SPNEGO to Authenticate with Kerberos over HTTP | ||
| ## What is Kerberos Authentication Protocol? | ||
|
|
||
| Kerberos is a network authentication protocol that works on the basis of tickets to allow nodes communicating over a non-secure network to prove their identity to one another in a secure manner. It uses strong cryptography so that a client can prove its identity to a server (and vice-versa) across an insecure network connection. | ||
|
|
||
| Key components of Kerberos include: | ||
|
|
||
| - **Clients:** Users or services requesting access. | ||
| - **Servers:** Services providing resources. | ||
| - **Key Distribution Center (KDC):** A trusted third party responsible for issuing tickets and managing user credentials. The KDC typically consists of an Authentication Server (AS) and a Ticket-Granting Server (TGS). | ||
| - **Principals:** Unique identities (users or services) within the Kerberos realm. | ||
|
|
||
| ## How Ozone uses Kerberos | ||
|
|
||
| In a secure, Kerberized Ozone cluster, all communication is authenticated to prevent unauthorized access and ensure integrity. Ozone leverages Kerberos for two primary authentication patterns: | ||
|
|
||
| ### Client-to-Service Authentication | ||
|
|
||
| Clients (e.g., `ozone sh`, Spark jobs) authenticate with Ozone services (e.g., Ozone Manager, SCM) by acquiring a Kerberos ticket-granting ticket (TGT) from the KDC. This TGT is then used to obtain service tickets for various Ozone services, proving the client's identity to each service. | ||
|
|
||
| ### Service-to-Service Authentication | ||
|
|
||
| Ozone's internal services (e.g., Ozone Manager to SCM, SCM to Datanodes, Datanodes to other Datanodes for replication) also authenticate with each other using Kerberos. Each service runs as a distinct Kerberos principal, and they use service tickets to establish trusted communication channels. For details on configuring Kerberos for Ozone services, refer to the [Configuring Kerberos page](../../../administrator-guide/configuration/security/kerberos). | ||
|
|
||
| ### Kerberos over HTTP using SPNEGO | ||
|
|
||
| For web-based interfaces and REST APIs (e.g., Recon UI, S3 Gateway), Kerberos authentication is often performed using SPNEGO (Simple and Protected GSSAPI Negotiation Mechanism). SPNEGO allows web clients (like browsers) to use their existing Kerberos credentials to authenticate with web servers without requiring explicit username/password input. For configuration details, see [Configuring HTTP authentication using Kerberos SPNEGO](../../../administrator-guide/configuration/security/https). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -135,6 +135,12 @@ const config = { | |
| sidebarPath: undefined, | ||
| editUrl: | ||
| 'https://github.com/apache/ozone-site/tree/master', | ||
| versions: { | ||
| current: { | ||
| label: 'Next', | ||
| banner: 'unreleased', | ||
| }, | ||
| }, | ||
| }, | ||
| blog: { | ||
| showReadingTime: true, | ||
|
|
@@ -213,24 +219,9 @@ const config = { | |
| }, | ||
| items: [ | ||
| { | ||
| label: 'Docs', | ||
| position: 'left', | ||
| items: [ | ||
| { | ||
| label: 'Latest Docs', | ||
| to: 'docs', | ||
| }, | ||
| { | ||
| label: 'Docs 2.0.0 (Archived)', | ||
| href: '/docs/2.0.0/', | ||
| target: '_blank' | ||
| }, | ||
| { | ||
| label: 'Docs 1.4.1 (Archived)', | ||
| href: '/docs/1.4.1/', | ||
| target: '_blank' | ||
| }, | ||
| ], | ||
| label: 'Docs', // New 'Docs' link | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Let's remove or rephrase these comments referring to "new" and "moved". Comments should reflect the current state of the change, not the diff. |
||
| to: 'docs/next', // Links to the 'Next' version | ||
| position: 'left', // Keep it on the left | ||
| }, | ||
| { | ||
| to: 'download', | ||
|
|
@@ -277,6 +268,26 @@ const config = { | |
| }, | ||
| ] | ||
| }, | ||
| { | ||
| type: 'docsVersionDropdown', // Moved to right | ||
| position: 'right', | ||
| dropdownItemsAfter: [ | ||
| { | ||
| type: 'html', | ||
| value: '<hr class="dropdown-separator">', | ||
| }, | ||
| { | ||
| label: 'Docs 2.0.0 (Archived)', | ||
| href: '/docs/2.0.0/', | ||
| target: '_blank', | ||
| }, | ||
| { | ||
| label: 'Docs 1.4.1 (Archived)', | ||
| href: '/docs/1.4.1/', | ||
| target: '_blank', | ||
| }, | ||
| ], | ||
| }, | ||
| { | ||
| type: 'localeDropdown', | ||
| position: 'right', | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this page was committed to the PR by mistake.