From 9e6062d5e3afd7fc32b96aa25e8b60ea20ad3aa6 Mon Sep 17 00:00:00 2001 From: Chris Date: Tue, 25 May 2021 09:58:41 +0200 Subject: [PATCH] Add explanation page to give an overview of the features --- docs/modules/ROOT/pages/explanations/.gitkeep | 0 .../pages/explanations/default-features.adoc | 16 ++++++++++++++++ docs/modules/ROOT/partials/nav.adoc | 3 +++ 3 files changed, 19 insertions(+) delete mode 100644 docs/modules/ROOT/pages/explanations/.gitkeep create mode 100644 docs/modules/ROOT/pages/explanations/default-features.adoc diff --git a/docs/modules/ROOT/pages/explanations/.gitkeep b/docs/modules/ROOT/pages/explanations/.gitkeep deleted file mode 100644 index e69de29b..00000000 diff --git a/docs/modules/ROOT/pages/explanations/default-features.adoc b/docs/modules/ROOT/pages/explanations/default-features.adoc new file mode 100644 index 00000000..ccf28a52 --- /dev/null +++ b/docs/modules/ROOT/pages/explanations/default-features.adoc @@ -0,0 +1,16 @@ += Default features + +Many Helm Charts in the Kubernetes community have advanced features disabled by default in order to ease installations without configuring much. +This is also the case with the Keycloak Helm chart this component depends upon. +However, this component aims to provision Keycloak secure by default, so a lot of defaults have activated advanced features. +This page gives an overview over the defaults. + +== Enabled features + +- Installs single-node PostgreSQL as the built-in database provider +- Encrypted connection to database +- Enabled network policies to protect from unexpected connections +- Prometheus ServiceMonitor to scrape metrics +- 2 replicas of Keycloak, with anti-affinity +- Enabled Ingress +- Configured requests and limits for CPU and memory resources diff --git a/docs/modules/ROOT/partials/nav.adoc b/docs/modules/ROOT/partials/nav.adoc index 153c49a0..f98c23e9 100644 --- a/docs/modules/ROOT/partials/nav.adoc +++ b/docs/modules/ROOT/partials/nav.adoc @@ -12,5 +12,8 @@ * xref:how-tos/upgrade-1.x-to-2.x.adoc[Upgrade 1.x to 2.x] * xref:how-tos/pin-versions.adoc[Pin versions] +.Explanations +* xref:explanations/default-features.adoc[Default features] + .Technical reference * xref:references/parameters.adoc[Parameters]