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
1 change: 1 addition & 0 deletions docs/modules/hbase/pages/getting_started/index.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Getting started
:description: Getting started with Apache HBase on Kubernetes, covering installation of the Stackable operator and its dependencies and a first HBase cluster.

This guide gets you started with HBase using the Stackable operator.
It guides you through the installation of the operator and its dependencies, setting up your first HBase cluster and verifying its operation.
Expand Down
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 HBase 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/hbase/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 HBase on the Stackable Hub, covering every field, default and API version.

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

= Discovery
:description: Reference for the discovery ConfigMap the Stackable operator for Apache HBase publishes, with the client configuration for connecting to the cluster.

The Stackable Operator for Apache HBase 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 HBase 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 HBase 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/hbase/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 HBase, covering CRD fields, discovery ConfigMap properties, command-line parameters and environment variables.

Consult the reference documentation section to find exhaustive information on:

Expand Down
1 change: 1 addition & 0 deletions docs/modules/hbase/pages/troubleshooting/index.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Troubleshooting
:description: Troubleshooting Apache HBase on the Stackable Data Platform, covering clients connecting with Kerberos while ZooKeeper only uses mutual TLS.

== HBase access with Kerberos authentication

Expand Down
1 change: 1 addition & 0 deletions docs/modules/hbase/pages/usage-guide/index.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Usage guide
:description: Guides for Apache HBase on Kubernetes, covering cluster operations, Pod placement, resource requests, logging, monitoring and Apache Phoenix.

Learn about xref:usage-guide/operations/cluster-operations.adoc[starting, stopping and pausing] your cluster.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Cluster operation
:description: Cluster operations for Apache HBase, covering how to pause reconciliation of a cluster or stop it entirely through its custom resource.

HBase 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 HBase masters, RegionServers and RestServers, covering the configurable shutdown timeout per role.

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

Expand Down
1 change: 1 addition & 0 deletions docs/modules/hbase/pages/usage-guide/operations/index.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Operations
:description: Operating Apache HBase with the Stackable operator, covering graceful shutdown, Pod disruptions, Pod placement 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,4 +1,5 @@
= Allowed Pod disruptions
:description: PodDisruptionBudgets the Stackable operator writes for Apache HBase masters, RegionServers and RestServers, and how to disable them.

You can configure the permitted Pod disruptions for HBase 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 HBase, covering default affinities that place RegionServers next to HDFS DataNodes and custom placement settings.
:page-aliases: pod_placement.adoc

You can configure Pod placement for HBase nodes as described in xref:concepts:operations/pod_placement.adoc[].
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Resource requests
:description: Stackable managed HBase defaults to minimal resource requests. Adjust CPU and memory limits for production clusters to ensure proper performance.

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

If no resources are configured explicitly, the HBase operator uses following defaults:

Expand Down
Loading