DOC: Explain Containerfile usage and fix docker build example #41213
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -24,6 +24,8 @@ 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 .` | ||
|
|
||
| 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. | ||
|
|
||
| .Containerfile: | ||
|
|
@@ -147,7 +149,11 @@ 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 | ||
|
Comment on lines
+152
to
+156
There was a problem hiding this comment. @ahus1 IIRC, we also have a logic somewhere to replace There was a problem hiding this comment. I'll check once I review that follow-up PR |
||
| ---- | ||
|
|
||
| <@profile.ifProduct> | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure if this note shouldn't have been excluded for product.
CC @ahus1
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes ... @mabartos or @somln, can you please wrap that? If you do it straight away, use the same issue number and create another PR.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the clarification, @ahus1!
@vmuzikar – I’ll submit a follow-up PR shortly with the note wrapped in
ifdef::!product[], referencing #41029.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@vmuzikar Good point, thanks for the additional consideration.