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.

Sign up for GitHub

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

Jump to bottom

docs: remove home module from refs (stackabletech/documentation#637) #567

Merged
merged 1 commit into from
Aug 1, 2024
Merged

docs: remove home module from refs (stackabletech/documentation#637) #567

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/modules/hdfs/pages/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ NOTE: This operator only works with images from the https://repo.stackable.tech/

== Roles

Three xref:home:concepts:roles-and-role-groups.adoc[roles] of the HDFS cluster are implemented:
Three xref:concepts:roles-and-role-groups.adoc[roles] of the HDFS cluster are implemented:

* DataNode - responsible for storing the actual data.
* JournalNode - responsible for keeping track of HDFS blocks and used to perform failovers in case the active NameNode
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/hdfs/pages/usage-guide/logging-log-aggregation.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ spec:
----

Further information on how to configure logging, can be found in
xref:home:concepts:logging.adoc[].
xref:concepts:logging.adoc[].
2 changes: 1 addition & 1 deletion docs/modules/hdfs/pages/usage-guide/monitoring.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ All services (with the exception of the Zookeeper daemon on the node names) run

The metrics endpoints are also used as liveliness probes by K8S.

See xref:home:operators:monitoring.adoc[] for more details.
See xref:operators:monitoring.adoc[] for more details.
2 changes: 1 addition & 1 deletion docs/modules/hdfs/pages/usage-guide/resources.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ The hdfs-operator will re-create the StatefulSet automatically.

== Resource Requests

include::home:concepts:stackable_resource_requests.adoc[]
include::concepts:stackable_resource_requests.adoc[]

A minimal HA setup consisting of 3 journalnodes, 2 namenodes and 2 datanodes has the following https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[resource requirements]:

Expand Down
6 changes: 3 additions & 3 deletions docs/modules/hdfs/pages/usage-guide/security.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
== Authentication
Currently the only supported authentication mechanism is Kerberos, which is disabled by default.
For Kerberos to work a Kerberos KDC is needed, which the users needs to provide.
The xref:home:secret-operator:secretclass.adoc#backend-kerberoskeytab[secret-operator documentation] states which kind of Kerberos servers are supported and how they can be configured.
The xref:secret-operator:secretclass.adoc#backend-kerberoskeytab[secret-operator documentation] states which kind of Kerberos servers are supported and how they can be configured.

IMPORTANT: Kerberos is supported staring from HDFS version 3.3.x

Expand All @@ -12,7 +12,7 @@ To configure HDFS to use Kerberos you first need to collect information about yo
Additionally you need a service-user, which the secret-operator uses to create create principals for the HDFS services.

=== 2. Create Kerberos SecretClass
Afterwards you need to enter all the needed information into a SecretClass, as described in xref:home:secret-operator:secretclass.adoc#backend-kerberoskeytab[secret-operator documentation].
Afterwards you need to enter all the needed information into a SecretClass, as described in xref:secret-operator:secretclass.adoc#backend-kerberoskeytab[secret-operator documentation].
The following guide assumes you have named your SecretClass `kerberos-hdfs`.

=== 3. Configure HDFS to use SecretClass
Expand Down Expand Up @@ -55,7 +55,7 @@ We have an https://github.com/stackabletech/hdfs-operator/blob/main/tests/templa

== Authorization
We currently don't support authorization yet.
In the future support will be added by writing an opa-authorizer to match our general xref:home:concepts:opa.adoc[] mechanisms.
In the future support will be added by writing an opa-authorizer to match our general xref:concepts:opa.adoc[] mechanisms.

In the meantime a very basic level of authorization can be reached by using `configOverrides` to set the `hadoop.user.group.static.mapping.overrides` property.
In thew following example the `dr.who=;nn=;nm=;jn=;` part is needed for HDFS internal operations and the user `testuser` is granted admin permissions.
Expand Down
Loading