libre.sh/keycloak-scim
3
0
Fork 0
Code Issues 15 Pull requests Releases Packages Activity Actions

docs: add an initial note about sizing to each of the install guides (#29330)

Browse source 
closes: #14188

Signed-off-by: Steve Hawkins <shawkins@redhat.com>
This commit is contained in:
Steven Hawkins 2024-05-07 04:01:09 -04:00 committed by GitHub
parent 653e62593b
commit c18a68b4e3
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/guides/getting-started/getting-started-docker.adoc
View file

@ -12,6 +12,8 @@ summary="Get started with {project_name} on Docker">
== Before you start == Before you start
include::templates/hw-requirements.adoc[]
Make sure you have Docker installed. Make sure you have Docker installed.
include::templates/start-keycloak-container.adoc[] include::templates/start-keycloak-container.adoc[]

2
docs/guides/getting-started/getting-started-kube.adoc
View file

@ -9,6 +9,8 @@ summary="Get started with {project_name} on Kubernetes">
== Before you start == Before you start
include::templates/hw-requirements.adoc[]
Make sure you have Minikube installed, ideally with the Ingress addon enabled. 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: To check if you have the Ingress addon enabled, enter the following command:

2
docs/guides/getting-started/getting-started-openshift.adoc
View file

@ -9,6 +9,8 @@ summary="Get started with {project_name} on OpenShift">
== Before you start == 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 . 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. local OpenShift cluster.

2
docs/guides/getting-started/getting-started-podman.adoc
View file

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

2
docs/guides/getting-started/getting-started-zip.adoc
View file

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

4
docs/guides/getting-started/templates/hw-requirements.adoc Normal file
View file

@ -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.