From c18a68b4e3b48f7bb976ed77fea4afc618372a2d Mon Sep 17 00:00:00 2001 From: Steven Hawkins Date: Tue, 7 May 2024 04:01:09 -0400 Subject: [PATCH] docs: add an initial note about sizing to each of the install guides (#29330) closes: #14188 Signed-off-by: Steve Hawkins --- docs/guides/getting-started/getting-started-docker.adoc | 2 ++ docs/guides/getting-started/getting-started-kube.adoc | 2 ++ docs/guides/getting-started/getting-started-openshift.adoc | 2 ++ docs/guides/getting-started/getting-started-podman.adoc | 2 ++ docs/guides/getting-started/getting-started-zip.adoc | 2 ++ docs/guides/getting-started/templates/hw-requirements.adoc | 4 ++++ 6 files changed, 14 insertions(+) create mode 100644 docs/guides/getting-started/templates/hw-requirements.adoc diff --git a/docs/guides/getting-started/getting-started-docker.adoc b/docs/guides/getting-started/getting-started-docker.adoc index dd0b00a823..dae6b69bcf 100644 --- 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 index 6594db4bd3..53ce341cdd 100644 --- 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 index a8ae230a60..8b341d3ec7 100644 --- 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 index 2a3029a451..51d1566075 100644 --- 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 index d1d2ed4423..c164bd9afc 100644 --- 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 new file mode 100644 index 0000000000..e5a49bb676 --- /dev/null +++ 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.