Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Command line parameters
:description: Command-line parameters the Stackable operator for Apache Hadoop HDFS accepts, with their default values and usage examples.

This operator accepts the following command line parameters:

Expand Down
1 change: 1 addition & 0 deletions docs/modules/hdfs/pages/reference/crds.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
= CRD Reference
:description: CRD reference for the Stackable operator for Apache Hadoop HDFS on the Stackable Hub, covering every field, default and API version.

Find all CRD reference for the Stackable Operator for Apache HDFS at: {crd-ref}{crd-ref-release}&operator=hdfs-operator.
1 change: 1 addition & 0 deletions docs/modules/hdfs/pages/reference/discovery.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
:page-aliases: discovery.adoc

= Discovery
:description: Reference for the discovery ConfigMap the Stackable operator for Apache Hadoop HDFS publishes, with the client configuration for accessing the cluster.

The Stackable Operator for Apache HDFS publishes a discovery https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#configmap-v1-core[ConfigMap], which exposes a client configuration bundle that allows access to the Apache HDFS cluster.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Environment variables
:description: Environment variables the Stackable operator for Apache Hadoop HDFS accepts, with their default values and what each one controls.

This operator accepts the following environment variables:

Expand Down
1 change: 1 addition & 0 deletions docs/modules/hdfs/pages/reference/index.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Reference
:description: Reference for the Stackable operator for Apache Hadoop HDFS, covering CRD fields, discovery ConfigMap properties, CLI parameters and environment variables.

Consult the reference documentation section to find exhaustive information on:

Expand Down
1 change: 1 addition & 0 deletions docs/modules/hdfs/pages/reference/troubleshooting.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Troubleshooting
:description: Recovery of an Apache Hadoop HDFS cluster whose NameNode formatting was interrupted and whose format-namenodes init container keeps failing.

[#init-container-format-namenode-fails]
== Init container format-namenodes fails
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@

= Cluster Operation
:description: Cluster operations for Apache Hadoop HDFS, covering how to pause reconciliation of a cluster or stop it entirely through its custom resource.

HDFS installations can be configured with different cluster operations like pausing reconciliation or stopping the cluster. See xref:concepts:operations/cluster_operations.adoc[cluster operations] for more details.
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Graceful shutdown
:description: Graceful shutdown of Apache Hadoop HDFS JournalNodes, NameNodes and DataNodes, covering the configurable shutdown timeout per role.

You can configure the graceful shutdown as described in xref:concepts:operations/graceful_shutdown.adoc[].

Expand Down
1 change: 1 addition & 0 deletions docs/modules/hdfs/pages/usage-guide/operations/index.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Operations
:description: Operating Apache Hadoop HDFS with the Stackable operator, covering graceful shutdown, Pod disruptions, Pod placement, rack awareness and cluster operations.

This section of the documentation is intended for the operations teams that maintain a Stackable Data Platform installation.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@

= Allowed Pod disruptions
:description: PodDisruptionBudgets for Apache Hadoop HDFS JournalNodes, NameNodes and DataNodes, and how to shorten rolling redeployments of large clusters.

You can configure the permitted Pod disruptions for HDFS nodes as described in xref:concepts:operations/pod_disruptions.adoc[].

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Pod placement
:description: Pod placement for Apache Hadoop HDFS NameNodes, DataNodes and JournalNodes, covering the default affinities and placement next to OPA.

You can configure Pod placement for HDFS nodes as described in xref:concepts:operations/pod_placement.adoc[].

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= HDFS Rack Awareness
:description: Rack awareness for Apache Hadoop HDFS on Kubernetes, covering how block replicas are spread across racks or zones for better fault tolerance.
:rack-awareness-docs: https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-common/RackAwareness.html
:hdfs-topology-provider: https://github.com/stackabletech/hdfs-utils/blob/v0.5.0/src/main/java/tech/stackable/hadoop/StackableTopologyProvider.java

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/hdfs/pages/usage-guide/resources.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ The hdfs-operator recreates the StatefulSet automatically.

== Resource Requests

include::home:concepts:stackable_resource_requests.adoc[]
include::concepts:partial$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
Loading