reference docs

docs/modules/hdfs/pages/commandline_args.adoc → docs/modules/hdfs/pages/reference/commandline-parameters.adoc

@@ -1,5 +1,8 @@
+= Command line parameters
 
-=== product-config
+This operator accepts the following command line parameters:
+
+== product-config
 
 *Default value*: `/etc/stackable/hdfs-operator/config-spec/properties.yaml`
 
@@ -12,7 +15,7 @@
 stackable-hdfs-operator run --product-config /foo/bar/properties.yaml
 ----
 
-=== watch-namespace
+== watch-namespace
 
 *Default value*: All namespaces
 

docs/modules/hdfs/pages/reference/crds.adoc

@@ -0,0 +1,3 @@
+= CRD Reference
+
+Find all CRD reference for the Stackable Operator for Apache HDFS at: {crd-docs-base-url}/hdfs-operator/{crd-docs-version}.

docs/modules/hdfs/pages/discovery.adoc → docs/modules/hdfs/pages/reference/discovery.adoc

@@ -1,9 +1,10 @@
 :clusterName: \{clusterName\}
 :namespace: \{namespace\}
+:page-aliases: discovery.adoc
 
 = Discovery
 
-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.
+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.
 
 == Example
 
@@ -22,15 +23,15 @@ spec:
       default: # <3>
   [...]
 ----
-<1> The name of the HDFS cluster, which is also the name of the created discovery `ConfigMap`.
-<2> The namespace of the discovery `ConfigMap`.
+<1> The name of the HDFS cluster, which is also the name of the created discovery ConfigMap.
+<2> The namespace of the discovery ConfigMap.
 <3> A role group name of the `namenode` role.
 
 The resulting discovery `ConfigMap` is located at `{namespace}/{clusterName}`.
 
 == Contents
 
-The `ConfigMap` data values are formatted as Hadoop XML files which allows simple mounting of that ConfigMap into pods that require access to HDFS.
+The ConfigMap data values are formatted as Hadoop XML files which allows simple mounting of that ConfigMap into pods that require access to HDFS.
 
 `core-site.xml`::
 Contains the `fs.DefaultFS` which defaults to `hdfs://{clusterName}/`.

docs/modules/hdfs/pages/env_var_args.adoc → docs/modules/hdfs/pages/reference/environment-variables.adoc

@@ -1,5 +1,8 @@
+= Environment variables
 
-=== PRODUCT_CONFIG
+This operator accepts the following environment variables:
+
+== PRODUCT_CONFIG
 
 *Default value*: `/etc/stackable/hdfs-operator/config-spec/properties.yaml`
 
@@ -25,7 +28,7 @@ docker run \
     docker.stackable.tech/stackable/hdfs-operator:latest
 ----
 
-=== WATCH_NAMESPACE
+== WATCH_NAMESPACE
 
 *Default value*: All namespaces
 

docs/modules/hdfs/pages/reference/index.adoc

@@ -0,0 +1,7 @@
+= Reference
+
+Consult the reference documentation section to find exhaustive information on:
+
+* Descriptions and default values of all properties in the CRDs used by this operator in the xref:reference/crds.adoc[].
+* The properties in the xref:reference/discovery.adoc[].
+* The xref:reference/commandline-parameters.adoc[] and xref:reference/environment-variables.adoc[] accepted by the operator.

docs/modules/hdfs/partials/nav.adoc

@@ -1,9 +1,6 @@
 * xref:hdfs:getting_started/index.adoc[]
 ** xref:hdfs:getting_started/installation.adoc[]
 ** xref:hdfs:getting_started/first_steps.adoc[]
-* xref:hdfs:configuration.adoc[]
-* Concepts
-** xref:hdfs:discovery.adoc[]
 * xref:hdfs:usage-guide/index.adoc[]
 ** xref:hdfs:usage-guide/listenerclass.adoc[]
 ** xref:hdfs:usage-guide/security.adoc[]
@@ -19,3 +16,9 @@
 *** xref:hdfs:usage-guide/operations/rack-awareness.adoc[]
 *** xref:hdfs:usage-guide/operations/pod-disruptions.adoc[]
 *** xref:hdfs:usage-guide/operations/graceful-shutdown.adoc[]
+* xref:hdfs:reference/index.adoc[]
+** xref:hdfs:reference/crds.adoc[]
+*** {crd-docs}/hdfs.stackable.tech/hdfscluster/v1alpha1/[HdfsCluster {external-link-icon}^]
+** xref:hdfs:reference/discovery.adoc[]
+** xref:hdfs:reference/commandline-parameters.adoc[]
+** xref:hdfs:reference/environment-variables.adoc[]