docs: hide Containerfile note in product docs

Closes #41029

Signed-off-by: Somin Park <ps4708@naver.com>
Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
This commit is contained in:
SoMin Park 2025-07-18 00:02:00 +09:00 committed by GitHub
parent 8d77dfaf72
commit 0ebf87920b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -24,7 +24,21 @@ For the best start up of your {project_name} container, build an image by runnin
This step will save time in every subsequent start phase of the container image.
=== Writing your optimized {project_name} Containerfile
NOTE: A Containerfile is functionally identical to a Dockerfile and uses the same syntax. The term "Containerfile" is used to be more tool-agnostic, especially in non-Docker environments like Podman or Buildah. When using Docker, you have two options: either name your file `Dockerfile` (which Docker expects by default), or keep the name `Containerfile` and specify it explicitly using the `-f` flag: `docker build -f Containerfile -t mykeycloak .`
<@profile.ifCommunity>
[NOTE]
====
A Containerfile is functionally identical to a Dockerfile and uses the same syntax.
The term "Containerfile" is used to be more tool-agnostic, especially in non-Docker environments like Podman or Buildah.
When using Docker, you have two options: either name your file `Dockerfile` (which Docker expects by default), or keep the name `Containerfile` and specify it explicitly using the `-f` flag:
----
docker build -f Containerfile -t mykeycloak .
----
====
</@profile.ifCommunity>
The following `Containerfile` creates a pre-configured {project_name} image that enables the health and metrics endpoints, enables the token exchange feature, and uses a PostgreSQL database.
@ -149,11 +163,7 @@ To build the actual container image, run the following command from the director
[source,bash]
----
podman build . -t mykeycloak
# or for Docker (specify the Containerfile explicitly):
docker build -f Containerfile . -t mykeycloak
# or rename Containerfile to Dockerfile and use:
docker build . -t mykeycloak
podman|docker build . -t mykeycloak -f Containerfile
----
<@profile.ifProduct>