From 40eb2122284cf7fb7a3c5bf39627336dc74fe1df Mon Sep 17 00:00:00 2001 From: Nick <10092581+NickLarsenNZ@users.noreply.github.com> Date: Fri, 2 Aug 2024 01:25:19 +1200 Subject: [PATCH] docs: remove home module from refs (stackabletech/documentation#637) (#611) --- docs/modules/druid/pages/index.adoc | 2 +- docs/modules/druid/pages/usage-guide/logging.adoc | 2 +- .../druid/pages/usage-guide/resources-and-storage.adoc | 4 ++-- docs/modules/druid/pages/usage-guide/security.adoc | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/modules/druid/pages/index.adoc b/docs/modules/druid/pages/index.adoc index 801a1853..ed79eb52 100644 --- a/docs/modules/druid/pages/index.adoc +++ b/docs/modules/druid/pages/index.adoc @@ -17,7 +17,7 @@ its dependencies (ZooKeeper, HDFS, an SQL database) and the steps to query your == Resources The Operator is installed along with the _DruidCluster_ CustomResourceDefinition, which supports five -xref:home:concepts:roles-and-role-groups.adoc[roles]: **Router**, **Coordinator**, **Broker**, **MiddleManager** and +xref:concepts:roles-and-role-groups.adoc[roles]: **Router**, **Coordinator**, **Broker**, **MiddleManager** and **Historical**. These roles correspond to https://druid.apache.org/docs/latest/design/processes.html[Druid processes]. The Operator watches DruidCluster objects and creates multiple Kubernetes resources for each DruidCluster based on its configuration. diff --git a/docs/modules/druid/pages/usage-guide/logging.adoc b/docs/modules/druid/pages/usage-guide/logging.adoc index 000c11c2..defa68d3 100644 --- a/docs/modules/druid/pages/usage-guide/logging.adoc +++ b/docs/modules/druid/pages/usage-guide/logging.adoc @@ -29,4 +29,4 @@ spec: enableVectorAgent: true ---- -Further information on how to configure logging, can be found in xref:home:concepts:logging.adoc[]. +Further information on how to configure logging, can be found in xref:concepts:logging.adoc[]. diff --git a/docs/modules/druid/pages/usage-guide/resources-and-storage.adoc b/docs/modules/druid/pages/usage-guide/resources-and-storage.adoc index e728aa2c..3cec0f68 100644 --- a/docs/modules/druid/pages/usage-guide/resources-and-storage.adoc +++ b/docs/modules/druid/pages/usage-guide/resources-and-storage.adoc @@ -6,7 +6,7 @@ Druid uses S3 or HDFS for deep storage, so no extra https://kubernetes.io/docs/c == Resource Requests -include::home:concepts:stackable_resource_requests.adoc[] +include::concepts:stackable_resource_requests.adoc[] A minimal HA setup consisting of 2 Pods of each role has the following https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[resource requirements]: @@ -63,7 +63,7 @@ spec: limit: 512Mi ---- -The operator may configure an additional container for log aggregation. This is done when log aggregation is configured as described in xref:concepts:logging.adoc[]. The resources for this container cannot be configured using the mechanism described above. Use xref:home:concepts:overrides.adoc#_pod_overrides[podOverrides] for this purpose. +The operator may configure an additional container for log aggregation. This is done when log aggregation is configured as described in xref:concepts:logging.adoc[]. The resources for this container cannot be configured using the mechanism described above. Use xref:concepts:overrides.adoc#_pod_overrides[podOverrides] for this purpose. You can configure your own resource requests and limits by following the example above. diff --git a/docs/modules/druid/pages/usage-guide/security.adoc b/docs/modules/druid/pages/usage-guide/security.adoc index 2c0c89fa..81ea1ea8 100644 --- a/docs/modules/druid/pages/usage-guide/security.adoc +++ b/docs/modules/druid/pages/usage-guide/security.adoc @@ -70,7 +70,7 @@ Reference the AuthenticationClass in your DruidCluster resource: include::example$druid-ldap-authentication.yaml[tag=druid] ---- -Check out the xref:tutorials:authentication_with_openldap.adoc[] tutorial to see a complete example of how to set LDAP authentication for another Stackable operator. You can also consult the home:reference:authenticationclass.adoc[] reference, or +Check out the xref:tutorials:authentication_with_openldap.adoc[] tutorial to see a complete example of how to set LDAP authentication for another Stackable operator. You can also consult the reference:authenticationclass.adoc[] reference, or https://github.com/stackabletech/druid-operator/tree/main/tests/templates/kuttl/ldap-authentication[the LDAP test] suite. === Current Limitations and Upcoming Work