From c28139bf05c5b2c17ecc6e4a32dcb07d2cf8dc65 Mon Sep 17 00:00:00 2001 From: Lars Francke Date: Thu, 5 Nov 2026 13:24:25 +0100 Subject: [PATCH 1/3] docs: Add page descriptions --- docs/modules/nifi/pages/reference/commandline-parameters.adoc | 1 + docs/modules/nifi/pages/reference/crds.adoc | 1 + docs/modules/nifi/pages/reference/environment-variables.adoc | 1 + docs/modules/nifi/pages/reference/index.adoc | 1 + docs/modules/nifi/pages/troubleshooting/index.adoc | 1 + .../nifi/pages/usage_guide/exposing-processors/index.adoc | 1 + docs/modules/nifi/pages/usage_guide/flow-versioning.adoc | 1 + .../nifi/pages/usage_guide/operations/cluster-operations.adoc | 1 + .../nifi/pages/usage_guide/operations/graceful-shutdown.adoc | 1 + docs/modules/nifi/pages/usage_guide/operations/index.adoc | 1 + .../nifi/pages/usage_guide/operations/pod-disruptions.adoc | 1 + .../modules/nifi/pages/usage_guide/operations/pod-placement.adoc | 1 + 12 files changed, 12 insertions(+) diff --git a/docs/modules/nifi/pages/reference/commandline-parameters.adoc b/docs/modules/nifi/pages/reference/commandline-parameters.adoc index 65812f3b..0ab57b3e 100644 --- a/docs/modules/nifi/pages/reference/commandline-parameters.adoc +++ b/docs/modules/nifi/pages/reference/commandline-parameters.adoc @@ -1,4 +1,5 @@ = Command line parameters +:description: Command-line parameters the Stackable operator for Apache NiFi accepts, with their default values and usage examples. This operator accepts the following command line parameters: diff --git a/docs/modules/nifi/pages/reference/crds.adoc b/docs/modules/nifi/pages/reference/crds.adoc index 37b042c4..2b0c60f4 100644 --- a/docs/modules/nifi/pages/reference/crds.adoc +++ b/docs/modules/nifi/pages/reference/crds.adoc @@ -1,3 +1,4 @@ = CRD Reference +:description: CRD reference for the Stackable operator for Apache NiFi on the Stackable Hub, covering every field, default and API version. Find all CRD reference for the Stackable Operator for Apache NiFi at: {crd-ref}{crd-ref-release}&operator=nifi-operator. diff --git a/docs/modules/nifi/pages/reference/environment-variables.adoc b/docs/modules/nifi/pages/reference/environment-variables.adoc index 181ec54e..0f798fb4 100644 --- a/docs/modules/nifi/pages/reference/environment-variables.adoc +++ b/docs/modules/nifi/pages/reference/environment-variables.adoc @@ -1,4 +1,5 @@ = Environment variables +:description: Environment variables the Stackable operator for Apache NiFi accepts, with their default values and what each one controls. This operator accepts the following environment variables: diff --git a/docs/modules/nifi/pages/reference/index.adoc b/docs/modules/nifi/pages/reference/index.adoc index 3cfa0289..8414f2da 100644 --- a/docs/modules/nifi/pages/reference/index.adoc +++ b/docs/modules/nifi/pages/reference/index.adoc @@ -1,4 +1,5 @@ = Reference +:description: Reference for the Stackable operator for Apache NiFi, covering CRD fields, command-line parameters and environment variables. Consult the reference documentation section to find exhaustive information on: diff --git a/docs/modules/nifi/pages/troubleshooting/index.adoc b/docs/modules/nifi/pages/troubleshooting/index.adoc index 9fcb7151..664738c4 100644 --- a/docs/modules/nifi/pages/troubleshooting/index.adoc +++ b/docs/modules/nifi/pages/troubleshooting/index.adoc @@ -1,4 +1,5 @@ = Troubleshooting +:description: Troubleshooting Apache NiFi on Kubernetes, covering a full log volume, Invalid SNI errors behind Ingress, OIDC login errors and nipyapi versions. :nipyapi: https://github.com/Chaffelson/nipyapi == Usage of EmptyDir volume "log" exceeds the limit diff --git a/docs/modules/nifi/pages/usage_guide/exposing-processors/index.adoc b/docs/modules/nifi/pages/usage_guide/exposing-processors/index.adoc index 1f7cfff3..58f9d5ed 100644 --- a/docs/modules/nifi/pages/usage_guide/exposing-processors/index.adoc +++ b/docs/modules/nifi/pages/usage_guide/exposing-processors/index.adoc @@ -1,4 +1,5 @@ = Exposing processors +:description: Exposing Apache NiFi processors outside the Kubernetes cluster, covering HTTP and generic TCP traffic and the mechanism that fits each. There are two mechanisms to expose Nifi processors to the outside world. diff --git a/docs/modules/nifi/pages/usage_guide/flow-versioning.adoc b/docs/modules/nifi/pages/usage_guide/flow-versioning.adoc index 92093135..807fafdb 100644 --- a/docs/modules/nifi/pages/usage_guide/flow-versioning.adoc +++ b/docs/modules/nifi/pages/usage_guide/flow-versioning.adoc @@ -1,4 +1,5 @@ = Flow Versioning +:description: Flow versioning for Apache NiFi in GitHub or GitLab repositories with flow registry clients, without a separate NiFi Registry service. You can connect directly to Git repositories using either GitHub or GitLab as your flow registry without requiring a separate NiFi Registry service. This document explains how to configure and use these registry clients to version your NiFi flows. diff --git a/docs/modules/nifi/pages/usage_guide/operations/cluster-operations.adoc b/docs/modules/nifi/pages/usage_guide/operations/cluster-operations.adoc index fe083c66..41b2420e 100644 --- a/docs/modules/nifi/pages/usage_guide/operations/cluster-operations.adoc +++ b/docs/modules/nifi/pages/usage_guide/operations/cluster-operations.adoc @@ -1,4 +1,5 @@ = Cluster operation +:description: Cluster operations for Apache NiFi, covering how to pause reconciliation of a cluster or stop it entirely through its custom resource. Apache NiFi installations can be configured with different cluster operations such as pausing reconciliation or stopping the cluster. See xref:concepts:operations/cluster_operations.adoc[cluster operations] for more details. diff --git a/docs/modules/nifi/pages/usage_guide/operations/graceful-shutdown.adoc b/docs/modules/nifi/pages/usage_guide/operations/graceful-shutdown.adoc index effd9045..b1ae47f5 100644 --- a/docs/modules/nifi/pages/usage_guide/operations/graceful-shutdown.adoc +++ b/docs/modules/nifi/pages/usage_guide/operations/graceful-shutdown.adoc @@ -1,4 +1,5 @@ = Graceful shutdown +:description: Graceful shutdown of Apache NiFi nodes, covering the configurable shutdown timeout and how the NiFi process stops. You can configure the graceful shutdown as described in xref:concepts:operations/graceful_shutdown.adoc[]. diff --git a/docs/modules/nifi/pages/usage_guide/operations/index.adoc b/docs/modules/nifi/pages/usage_guide/operations/index.adoc index 21d170f9..c8445cf3 100644 --- a/docs/modules/nifi/pages/usage_guide/operations/index.adoc +++ b/docs/modules/nifi/pages/usage_guide/operations/index.adoc @@ -1,4 +1,5 @@ = Operations +:description: Operating Apache NiFi 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. diff --git a/docs/modules/nifi/pages/usage_guide/operations/pod-disruptions.adoc b/docs/modules/nifi/pages/usage_guide/operations/pod-disruptions.adoc index 2030ead9..31e33ac5 100644 --- a/docs/modules/nifi/pages/usage_guide/operations/pod-disruptions.adoc +++ b/docs/modules/nifi/pages/usage_guide/operations/pod-disruptions.adoc @@ -1,4 +1,5 @@ = Allowed Pod disruptions +:description: The PodDisruptionBudget the Stackable operator writes for Apache NiFi nodes, and how to disable it. You can configure the permitted Pod disruptions for NiFi nodes as described in xref:concepts:operations/pod_disruptions.adoc[]. diff --git a/docs/modules/nifi/pages/usage_guide/operations/pod-placement.adoc b/docs/modules/nifi/pages/usage_guide/operations/pod-placement.adoc index 964d2631..fbcabb18 100644 --- a/docs/modules/nifi/pages/usage_guide/operations/pod-placement.adoc +++ b/docs/modules/nifi/pages/usage_guide/operations/pod-placement.adoc @@ -1,4 +1,5 @@ = Pod placement +:description: Pod placement for Apache NiFi, covering the default affinities and placement next to OPA when OPA authorization is configured. You can configure the Pod placement of the NiFi pods as described in xref:concepts:operations/pod_placement.adoc[]. From 7075a0a1030e77163f1b816608a284306928ce0e Mon Sep 17 00:00:00 2001 From: Lars Francke Date: Thu, 5 Nov 2026 13:24:25 +0100 Subject: [PATCH 2/3] docs: Include the resource requests partial --- docs/modules/nifi/pages/usage_guide/resource-configuration.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/nifi/pages/usage_guide/resource-configuration.adoc b/docs/modules/nifi/pages/usage_guide/resource-configuration.adoc index bc002a53..7c0387ef 100644 --- a/docs/modules/nifi/pages/usage_guide/resource-configuration.adoc +++ b/docs/modules/nifi/pages/usage_guide/resource-configuration.adoc @@ -36,7 +36,7 @@ In the above example, all nodes in the default group request `12Gi` of storage t == Resource requests -include::home:concepts:stackable_resource_requests.adoc[] +include::home:concepts:partial$stackable_resource_requests.adoc[] A minimal HA setup consisting of 2 NiFi instances has the following https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[resource requirements]: From 0971ac647b2f83a4c3dd2ec16ab002bfac8df057 Mon Sep 17 00:00:00 2001 From: Lars Francke Date: Thu, 5 Nov 2026 16:57:01 +0100 Subject: [PATCH 3/3] docs: Fix the resource requests include --- docs/modules/nifi/pages/usage_guide/resource-configuration.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/nifi/pages/usage_guide/resource-configuration.adoc b/docs/modules/nifi/pages/usage_guide/resource-configuration.adoc index 7c0387ef..dda3b05e 100644 --- a/docs/modules/nifi/pages/usage_guide/resource-configuration.adoc +++ b/docs/modules/nifi/pages/usage_guide/resource-configuration.adoc @@ -36,7 +36,7 @@ In the above example, all nodes in the default group request `12Gi` of storage t == Resource requests -include::home:concepts:partial$stackable_resource_requests.adoc[] +include::concepts:partial$stackable_resource_requests.adoc[] A minimal HA setup consisting of 2 NiFi instances has the following https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[resource requirements]: