Add explanation page to give an overview of the features

projectsyn · May 25, 2021 · 9e6062d · 9e6062d
1 parent 57ca18e
commit 9e6062d
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 0 deletions.
diff --git a/docs/modules/ROOT/pages/explanations/.gitkeep b/docs/modules/ROOT/pages/explanations/.gitkeep
diff --git a/docs/modules/ROOT/pages/explanations/default-features.adoc 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
@@ -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]