docs: add an initial note about sizing to each of the install guides (k…

…eycloak#29330) closes: keycloak#14188 Signed-off-by: Steve Hawkins <[email protected]>
pedroigor · May 7, 2024 · c18a68b · c18a68b
1 parent 653e625
commit c18a68b
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 0 deletions.
diff --git a/docs/guides/getting-started/getting-started-docker.adoc b/docs/guides/getting-started/getting-started-docker.adoc
@@ -12,6 +12,8 @@ summary="Get started with {project_name} on Docker">
 
 == Before you start
 
+include::templates/hw-requirements.adoc[]
+
 Make sure you have Docker installed.
 
 include::templates/start-keycloak-container.adoc[]

diff --git a/docs/guides/getting-started/getting-started-kube.adoc b/docs/guides/getting-started/getting-started-kube.adoc
@@ -9,6 +9,8 @@ summary="Get started with {project_name} on Kubernetes">
 
 == Before you start
 
+include::templates/hw-requirements.adoc[]
+
 Make sure you have Minikube installed, ideally with the Ingress addon enabled.
 
 To check if you have the Ingress addon enabled, enter the following command:

diff --git a/docs/guides/getting-started/getting-started-openshift.adoc b/docs/guides/getting-started/getting-started-openshift.adoc
@@ -9,6 +9,8 @@ summary="Get started with {project_name} on OpenShift">
 
 == Before you start
 
+include::templates/hw-requirements.adoc[]
+
 . Install https://code-ready.github.io/crc/[Red Hat Code Ready Containers] and follow the steps in the documentation to install a 
 local OpenShift cluster.
 

diff --git a/docs/guides/getting-started/getting-started-podman.adoc b/docs/guides/getting-started/getting-started-podman.adoc
@@ -12,6 +12,8 @@ summary="Get started with {project_name} on Podman">
 
 == Before you start
 
+include::templates/hw-requirements.adoc[]
+
 Make sure you have Podman installed.
 
 include::templates/start-keycloak-container.adoc[]

diff --git a/docs/guides/getting-started/getting-started-zip.adoc b/docs/guides/getting-started/getting-started-zip.adoc
@@ -11,6 +11,8 @@ summary="Get started with {project_name} on bare metal">
 
 == Before you start
 
+include::templates/hw-requirements.adoc[]
+
 Make sure you have https://openjdk.java.net/[OpenJDK 17] installed. 
 
 == Download {project_name}

diff --git a/docs/guides/getting-started/templates/hw-requirements.adoc b/docs/guides/getting-started/templates/hw-requirements.adoc
@@ -0,0 +1,4 @@
+<#import "/templates/links.adoc" as links>
+
+Make sure your machine or container platform can provide sufficient memory and CPU for your desired usage of {project_name}. 
+See <@links.ha id="concepts-memory-and-cpu-sizing" /> for more on how to get started with production sizing.