From 52243bbafdb047ad912edf7acf49c23808db3514 Mon Sep 17 00:00:00 2001 From: xeniape <xenia.fischer@stackable.tech> Date: Thu, 20 Mar 2025 16:17:19 +0100 Subject: [PATCH 1/6] docs: add documentation for demo code --- docs/modules/demos/pages/index.adoc | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/modules/demos/pages/index.adoc b/docs/modules/demos/pages/index.adoc index 0e8b83cc..d4e9db1f 100644 --- a/docs/modules/demos/pages/index.adoc +++ b/docs/modules/demos/pages/index.adoc @@ -27,3 +27,16 @@ Below you can find a list of components that are currently contained in one or m * Prometheus * Redis ==== + +== Demo Code + +The manifests and code used by the demos, can be found in the https://github.com/stackabletech/demos[demo repository,window=_blank]. Each demo is constructed in the following way: + +* `demos/demos-v2.yaml` file: lists the available demos and uses additional parameters to build up the demo, e.g. + ** `stackableStack` references the stack belonging to this demo + ** `manifests` includes a list of additional manifests for the demo, mostly jobs to create tables or ingest example data + ** `resourceRequests` specifying the needed resources for the demo to run +* `stacks/stacks-v2.yaml` file: lists the available stacks, which are referenced by the `demos/demos-v2.yaml` file, and uses additional parameters to build up the demo, e.g. + ** `stackableOperators` are all the operators that are installed as part of the demo + ** `manifests` contains all the manifests needed to setup the products and third-party tools + ** `parameters` is a list of values used in the manifest files, for example as credentials or other settings From f9a65d56b1e8bdc554110952283d4082c3f25412 Mon Sep 17 00:00:00 2001 From: Malte Sander <malte.sander.it@gmail.com> Date: Thu, 20 Mar 2025 17:02:22 +0100 Subject: [PATCH 2/6] sneaky: extend external components, improve message --- docs/modules/demos/pages/index.adoc | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/modules/demos/pages/index.adoc b/docs/modules/demos/pages/index.adoc index d4e9db1f..fa4401f3 100644 --- a/docs/modules/demos/pages/index.adoc +++ b/docs/modules/demos/pages/index.adoc @@ -10,15 +10,17 @@ include::partial$demos.adoc[] [IMPORTANT] .External Components in these demos ==== -These demos are provided by Stackable as showcases to demonstrate potential architectures that could be built with the Stackable Data Platform. -As such they may include components that are not supported by Stackable as part of our commercial offering. +The demos provided by Stackable serve as showcases to illustrate potential architectures that can be built using the Stackable Data Platform. +Please note that these demos may include components that are not supported by Stackable as part of our commercial offering. -If you are evaluating one or more of these demos with the intention of purchasing a subscription, make sure to double-check the list of supported operators; anything that is not mentioned on there is not part of our commercial offering. +If you are evaluating these demos with the intention of purchasing a subscription, please ensure that you review the xref:operators:index.adoc[list of supported operators]. +Any components not listed there are not part of our commercial offering. -Below you can find a list of components that are currently contained in one or more of the demos for reference, if something is missing from this list and also not mentioned on our operators list, then this component is not supported: +Below is an incomplete list of third-party components referenced in these demos: * Grafana * JupyterHub +* Keycloak * MinIO * OpenLDAP * OpenSearch @@ -26,6 +28,7 @@ Below you can find a list of components that are currently contained in one or m * PostgreSQL * Prometheus * Redis +* Vector Aggregator ==== == Demo Code From c46d7e2d52731767516d524d93eef12351500485 Mon Sep 17 00:00:00 2001 From: Xenia <xenia.fischer@stackable.tech> Date: Thu, 20 Mar 2025 17:57:28 +0100 Subject: [PATCH 3/6] Update docs/modules/demos/pages/index.adoc Co-authored-by: Malte Sander <malte.sander.it@gmail.com> --- docs/modules/demos/pages/index.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/demos/pages/index.adoc b/docs/modules/demos/pages/index.adoc index fa4401f3..093a454d 100644 --- a/docs/modules/demos/pages/index.adoc +++ b/docs/modules/demos/pages/index.adoc @@ -39,7 +39,7 @@ The manifests and code used by the demos, can be found in the https://github.com ** `stackableStack` references the stack belonging to this demo ** `manifests` includes a list of additional manifests for the demo, mostly jobs to create tables or ingest example data ** `resourceRequests` specifying the needed resources for the demo to run -* `stacks/stacks-v2.yaml` file: lists the available stacks, which are referenced by the `demos/demos-v2.yaml` file, and uses additional parameters to build up the demo, e.g. +* `stacks/stacks-v2.yaml` file: lists the available stacks, which are referenced by the `demos/demos-v2.yaml` file, and uses additional parameters to build up the underlying stack, e.g. ** `stackableOperators` are all the operators that are installed as part of the demo ** `manifests` contains all the manifests needed to setup the products and third-party tools ** `parameters` is a list of values used in the manifest files, for example as credentials or other settings From 4df03fe1fa1c53a32ea27c8c3453552d8eca4193 Mon Sep 17 00:00:00 2001 From: Xenia <xenia.fischer@stackable.tech> Date: Fri, 21 Mar 2025 08:52:55 +0100 Subject: [PATCH 4/6] Update docs/modules/demos/pages/index.adoc Co-authored-by: Sebastian Bernauer <sebastian.bernauer@stackable.de> --- docs/modules/demos/pages/index.adoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/modules/demos/pages/index.adoc b/docs/modules/demos/pages/index.adoc index 093a454d..834b08de 100644 --- a/docs/modules/demos/pages/index.adoc +++ b/docs/modules/demos/pages/index.adoc @@ -33,7 +33,8 @@ Below is an incomplete list of third-party components referenced in these demos: == Demo Code -The manifests and code used by the demos, can be found in the https://github.com/stackabletech/demos[demo repository,window=_blank]. Each demo is constructed in the following way: +The manifests and code used by the demos, can be found in the https://github.com/stackabletech/demos[demo repository,window=_blank]. +Each demo is constructed in the following way: * `demos/demos-v2.yaml` file: lists the available demos and uses additional parameters to build up the demo, e.g. ** `stackableStack` references the stack belonging to this demo From ac6cc7eca2b43fde74e025a698374c7713121d12 Mon Sep 17 00:00:00 2001 From: xeniape <xenia.fischer@stackable.tech> Date: Fri, 21 Mar 2025 10:08:53 +0100 Subject: [PATCH 5/6] add link to demos/stacks customization section --- docs/modules/demos/pages/index.adoc | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/modules/demos/pages/index.adoc b/docs/modules/demos/pages/index.adoc index 834b08de..88542480 100644 --- a/docs/modules/demos/pages/index.adoc +++ b/docs/modules/demos/pages/index.adoc @@ -44,3 +44,5 @@ Each demo is constructed in the following way: ** `stackableOperators` are all the operators that are installed as part of the demo ** `manifests` contains all the manifests needed to setup the products and third-party tools ** `parameters` is a list of values used in the manifest files, for example as credentials or other settings + +For more information on how to add custom demos/stacks, refer to the xref:management:stackablectl:customization/index.adoc[Customization section of SDP Management,window=_blank]. From e5b7b7193341802034c7ef2265efddad88e6d1d4 Mon Sep 17 00:00:00 2001 From: Xenia <xenia.fischer@stackable.tech> Date: Fri, 21 Mar 2025 10:15:47 +0100 Subject: [PATCH 6/6] Update docs/modules/demos/pages/index.adoc Co-authored-by: Sebastian Bernauer <sebastian.bernauer@stackable.de> --- docs/modules/demos/pages/index.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/demos/pages/index.adoc b/docs/modules/demos/pages/index.adoc index 88542480..82337d80 100644 --- a/docs/modules/demos/pages/index.adoc +++ b/docs/modules/demos/pages/index.adoc @@ -45,4 +45,4 @@ Each demo is constructed in the following way: ** `manifests` contains all the manifests needed to setup the products and third-party tools ** `parameters` is a list of values used in the manifest files, for example as credentials or other settings -For more information on how to add custom demos/stacks, refer to the xref:management:stackablectl:customization/index.adoc[Customization section of SDP Management,window=_blank]. +For more information on how to add custom demos/stacks, refer to the xref:management:stackablectl:customization/index.adoc[Customization section of stackablectl,window=_blank].