From b996e36d6c3b47942c01cf0b265925d87e64e36f Mon Sep 17 00:00:00 2001 From: Felix Hennig Date: Sun, 24 Dec 2023 13:11:33 +0100 Subject: [PATCH] reference docs --- docs/modules/hdfs/pages/configuration.adoc | 13 ------------- .../commandline-parameters.adoc} | 7 +++++-- docs/modules/hdfs/pages/reference/crds.adoc | 3 +++ .../hdfs/pages/{ => reference}/discovery.adoc | 9 +++++---- .../environment-variables.adoc} | 7 +++++-- docs/modules/hdfs/pages/reference/index.adoc | 7 +++++++ docs/modules/hdfs/partials/nav.adoc | 9 ++++++--- 7 files changed, 31 insertions(+), 24 deletions(-) delete mode 100644 docs/modules/hdfs/pages/configuration.adoc rename docs/modules/hdfs/pages/{commandline_args.adoc => reference/commandline-parameters.adoc} (78%) create mode 100644 docs/modules/hdfs/pages/reference/crds.adoc rename docs/modules/hdfs/pages/{ => reference}/discovery.adoc (72%) rename docs/modules/hdfs/pages/{env_var_args.adoc => reference/environment-variables.adoc} (90%) create mode 100644 docs/modules/hdfs/pages/reference/index.adoc diff --git a/docs/modules/hdfs/pages/configuration.adoc b/docs/modules/hdfs/pages/configuration.adoc deleted file mode 100644 index 65ff9ab4..00000000 --- a/docs/modules/hdfs/pages/configuration.adoc +++ /dev/null @@ -1,13 +0,0 @@ -= Configuration - -== Command Line Parameters - -This operator accepts the following command line parameters: - -include::commandline_args.adoc[] - -== Environment variables - -This operator accepts the following environment variables: - -include::env_var_args.adoc[] diff --git a/docs/modules/hdfs/pages/commandline_args.adoc b/docs/modules/hdfs/pages/reference/commandline-parameters.adoc similarity index 78% rename from docs/modules/hdfs/pages/commandline_args.adoc rename to docs/modules/hdfs/pages/reference/commandline-parameters.adoc index 2957bce5..01d95016 100644 --- a/docs/modules/hdfs/pages/commandline_args.adoc +++ b/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 diff --git a/docs/modules/hdfs/pages/reference/crds.adoc b/docs/modules/hdfs/pages/reference/crds.adoc new file mode 100644 index 00000000..97947b3b --- /dev/null +++ b/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}. \ No newline at end of file diff --git a/docs/modules/hdfs/pages/discovery.adoc b/docs/modules/hdfs/pages/reference/discovery.adoc similarity index 72% rename from docs/modules/hdfs/pages/discovery.adoc rename to docs/modules/hdfs/pages/reference/discovery.adoc index 84830943..ed961259 100644 --- a/docs/modules/hdfs/pages/discovery.adoc +++ b/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}/`. diff --git a/docs/modules/hdfs/pages/env_var_args.adoc b/docs/modules/hdfs/pages/reference/environment-variables.adoc similarity index 90% rename from docs/modules/hdfs/pages/env_var_args.adoc rename to docs/modules/hdfs/pages/reference/environment-variables.adoc index 79480027..ebd8e7ed 100644 --- a/docs/modules/hdfs/pages/env_var_args.adoc +++ b/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 diff --git a/docs/modules/hdfs/pages/reference/index.adoc b/docs/modules/hdfs/pages/reference/index.adoc new file mode 100644 index 00000000..eeb572f1 --- /dev/null +++ b/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. diff --git a/docs/modules/hdfs/partials/nav.adoc b/docs/modules/hdfs/partials/nav.adoc index f3eaddf5..15c2b405 100644 --- a/docs/modules/hdfs/partials/nav.adoc +++ b/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[] \ No newline at end of file