Docs: Create procedure for Deploying on OpenShift using Docker build strategy #45918

sheilamjones · 2025-01-28T11:46:35Z

This PR aims to draft a procedure for the following use case

Build and deploy Quarkus applications on OpenShift using the docker build strategy.

Reference: Based on the Red Hat build of Quarkus guide Deploying on OpenShift Container Platform

quarkus-bot · 2025-01-28T11:46:39Z

Thanks for your pull request!

Your pull request does not follow our editorial rules. Could you have a look?

title should preferably start with an uppercase character (if it makes sense!)

_{This message is automatically generated by a bot.}

Signed-off-by: shjones <[email protected]>

quarkus-bot · 2025-02-05T16:43:32Z

Status for workflow `Quarkus Documentation CI`

This is the status report for running Quarkus Documentation CI on commit b87770d.

✅ The latest workflow run for the pull request has completed successfully.

It should be safe to merge provided you have a look at the other checks in the summary.

github-actions · 2025-02-05T16:47:22Z

🎊 PR Preview 17b634f has been successfully built and deployed to https://quarkus-pr-main-45918-preview.surge.sh/version/main/guides/

Images of blog posts older than 3 months are not available.
Newsletters older than 3 months are not available.

sheilamjones · 2025-02-05T16:47:53Z

Hi @iocanel,
Can I please get your review of this procedure. Again, this content is based on the existing downstream Deploying on Openshift guide.
Many thanks,
Sheila

rolfedh

I changed some items to bullet points to better reflect that they are a collection of independent options rather than a sequence of steps. Additionally, to make it clearer that these options are optional, I replaced the imperative verb form with the infinitive "To ..." form. Feel free to apply this approach to any other PRs that include similar lists of optional steps.

rolfedh · 2025-02-07T16:17:38Z

docs/src/main/asciidoc/deploying-to-openshift-docker-howto.adoc

+As an application developer, you can deploy your applications to {openshift} by using the Docker build strategy as a deployment option.
+This functionality is provided by the `quarkus-openshift` extension.
+
+The container gets built inside the {openshift} cluster and is provided as an image stream.


Suggested change

The container gets built inside the {openshift} cluster and is provided as an image stream.

The {openshift} cluster builds the container and provides it as an image stream.

rolfedh · 2025-02-07T16:19:50Z

docs/src/main/asciidoc/deploying-to-openshift-docker-howto.adoc

+The container gets built inside the {openshift} cluster and is provided as an image stream.
+
+Your Quarkus project includes pregenerated Dockerfiles with instructions.
+When you want to use a custom Dockerfile, you must add the file in the `src/main/docker` directory or anywhere inside the module. Additionally, you must set the path to your Dockerfile by using the `quarkus.openshift.jvm-dockerfile` property.


Suggested change

When you want to use a custom Dockerfile, you must add the file in the `src/main/docker` directory or anywhere inside the module. Additionally, you must set the path to your Dockerfile by using the `quarkus.openshift.jvm-dockerfile` property.

If you want to use a custom Dockerfile, add the file to the `src/main/docker` directory or any location inside the module. Additionally, set the path to your Dockerfile by using the `quarkus.openshift.jvm-dockerfile` property.

rolfedh · 2025-02-07T16:20:52Z

docs/src/main/asciidoc/deploying-to-openshift-docker-howto.adoc

+* You have set the `JAVA_HOME` environment variable to the location of the Java SDK.
+* You have Apache Maven {maven-version} installed.
+* You have a Quarkus project that includes the `quarkus-openshift` extension.
+* You have access to a {openshift} cluster and the latest compatible version of the `oc` tool installed.


Suggested change

* You have access to a {openshift} cluster and the latest compatible version of the `oc` tool installed.

* You have access to a {openshift} cluster and the latest compatible version of the `oc` CLI tool installed.

rolfedh · 2025-02-07T16:21:51Z

docs/src/main/asciidoc/deploying-to-openshift-docker-howto.adoc

+----
+quarkus.openshift.build-strategy=docker
+----
+. Optional: Set the following properties in the `application.properties` file, as required by your environment:


Suggested change

. Optional: Set the following properties in the `application.properties` file, as required by your environment:

. Optional: Set the following properties in the `application.properties` file based on your environment:

rolfedh · 2025-02-07T16:23:00Z

docs/src/main/asciidoc/deploying-to-openshift-docker-howto.adoc

+quarkus.openshift.build-strategy=docker
+----
+. Optional: Set the following properties in the `application.properties` file, as required by your environment:
+.. If you are using an untrusted certificate, configure the `KubernetesClient`:


Suggested change

.. If you are using an untrusted certificate, configure the `KubernetesClient`:

** If you are using an untrusted certificate, enable certificate trust for the `KubernetesClient`:

rolfedh · 2025-02-07T16:40:14Z

docs/src/main/asciidoc/deploying-to-openshift-docker-howto.adoc

+----
+quarkus.kubernetes-client.trust-certs=true
+----
+.. Expose the service to create an {openshift} route:


Suggested change

.. Expose the service to create an {openshift} route:

** To expose the service and create an {openshift} route, set the following property:

rolfedh · 2025-02-07T16:43:01Z

docs/src/main/asciidoc/deploying-to-openshift-docker-howto.adoc

+----
+quarkus.openshift.route.expose=true
+----
+.. Set the path to your custom Dockerfile:


Suggested change

.. Set the path to your custom Dockerfile:

** To use a custom Dockerfile instead of the pregenerated Dockerfiles, set the path to your Dockerfile:

rolfedh · 2025-02-07T16:47:45Z

docs/src/main/asciidoc/deploying-to-openshift-docker-howto.adoc

+quarkus.openshift.jvm-dockerfile=<path_to_your_dockerfile>
+----
+The following example shows the path to the `Dockerfile.custom-jvm`:
+
+[source,properties]
+----
+quarkus.openshift.jvm-dockerfile=src/main/resources/Dockerfile.custom-jvm


Suggested change

quarkus.openshift.jvm-dockerfile=<path_to_your_dockerfile>

----

The following example shows the path to the `Dockerfile.custom-jvm`:

+

[source,properties]

----

quarkus.openshift.jvm-dockerfile=src/main/resources/Dockerfile.custom-jvm

quarkus.openshift.jvm-dockerfile=<path_to_your_dockerfile>

----

+

.Example path to the `Dockerfile.custom-jvm`

[source,properties]

----

quarkus.openshift.jvm-dockerfile=src/main/resources/Dockerfile.custom-jvm

Or maybe use:

For example, to specify a custom Dockerfile named `Dockerfile.custom-jvm`:

They key thing is to use the + so the example indent and aligns with the bullet point.

rolfedh

Hi Sheila,

Great work! With your agreement, I’ve taken the opportunity to provide a more thorough review. I hope you find it helpful. Feel free to apply or disregard any suggestions as you see fit.
Thanks!

rolfedh · 2025-02-07T16:59:04Z

docs/src/main/asciidoc/deploying-to-openshift-docker-howto.adoc

+quarkus.openshift.jvm-dockerfile=src/main/resources/Dockerfile.custom-jvm
+----
+
+. Package and deploy your application to the current OpenShift project:


Suggested change

. Package and deploy your application to the current OpenShift project:

. Package and deploy your application to the current {openshift} project:

rolfedh · 2025-02-07T17:02:18Z

docs/src/main/asciidoc/deploying-to-openshift-docker-howto.adoc

+
+== Verification
+
+The verification steps and related terminal outputs are demonstrated on the `openshift-helloworld` example application.


Suggested change

The verification steps and related terminal outputs are demonstrated on the `openshift-helloworld` example application.

The following verification steps use the `openshift-helloworld` example application.

Where is this example located? Should we provide a link for clarity? I couldn’t find it in Quarkus Quickstarts...

rolfedh · 2025-02-07T17:08:29Z

docs/src/main/asciidoc/deploying-to-openshift-docker-howto.adoc

+. To retrieve the log output for your application's pod, use the `oc logs -f` command with the `<pod_name>` value of the pod you are interested in.
+In this example, we use the `openshift-helloworld-1-gzzrx` pod name that corresponds with the latest pod prefixed with the name of your application:


Suggested change

. To retrieve the log output for your application's pod, use the `oc logs -f` command with the `<pod_name>` value of the pod you are interested in.

In this example, we use the `openshift-helloworld-1-gzzrx` pod name that corresponds with the latest pod prefixed with the name of your application:

. To get the log output for your application's pod, use the `oc logs -f` command with its name. For example:

rolfedh · 2025-02-07T17:09:30Z

docs/src/main/asciidoc/deploying-to-openshift-docker-howto.adoc

+oc logs -f _openshift-helloworld-1-gzzrx_
+----
+
+[source,shell,subs=attributes+]


Suggested change

[source,shell,subs=attributes+]

.Example output

[source,shell,subs=attributes+]

I'm unsure whether we want to label outputs, but if we do, we should aim to apply it consistently across all upstream-downstream documentation. Something to think about for the future.

rolfedh · 2025-02-07T17:10:12Z

docs/src/main/asciidoc/deploying-to-openshift-docker-howto.adoc

+2024-09-17 10:23:25,281 INFO  [io.quarkus] (main) Installed features: [cdi, kubernetes, rest, smallrye-context-propagation, vertx]
+----
+
+. Retrieve a list of services:


Suggested change

. Retrieve a list of services:

. To get a list of services:

rolfedh · 2025-02-07T17:26:36Z

docs/src/main/asciidoc/deploying-to-openshift-docker-howto.adoc

+. Get a URL to test your application.
+
+[NOTE]
+====
+To create an {openshift} route, ensure you have specified `quarkus.openshift.route.expose=true` in the `application.properties` file.
+====


Suggested change

. Get a URL to test your application.

+

[NOTE]

====

To create an {openshift} route, ensure you have specified `quarkus.openshift.route.expose=true` in the `application.properties` file.

====

. If you exposed an {openshift} route by setting the `quarkus.openshift.route.expose=true` property before building the application, you can get a URL to test it:

rolfedh · 2025-02-07T17:36:43Z

docs/src/main/asciidoc/deploying-to-openshift-docker-howto.adoc

+
+[NOTE]
+====
+Be aware that the route is now listening on port 80 and no longer at port 8080.


I'd double-check with the SME correctness of the current statement. Is the route is listening on port 80 in addition to port 8080? If so, maybe:

Suggested change

Be aware that the route is now listening on port 80 and no longer at port 8080.

Be aware that the route is now listening on port 80.

sheilamjones marked this pull request as draft January 28, 2025 11:46

quarkus-bot bot added the area/documentation label Jan 28, 2025

sheilamjones force-pushed the QDOCS-1060-docker branch from ea3166e to d431deb Compare January 28, 2025 11:49

sheilamjones force-pushed the QDOCS-1060-docker branch from d431deb to 54134b5 Compare February 5, 2025 02:20

sheilamjones marked this pull request as ready for review February 5, 2025 10:21

sheilamjones requested a review from iocanel February 5, 2025 10:21

sheilamjones changed the title ~~[DOCS]: Create procedure for Deploying on OpenShift using Docker build strategy~~ Docs: Create procedure for Deploying on OpenShift using Docker build strategy Feb 5, 2025

sheilamjones added 3 commits February 5, 2025 16:18

QDOCS-1060: create docker build procedures

3013152

Signed-off-by: shjones <[email protected]>

QDOCS-1060: fix attribtes and minor edits

4699d8f

Signed-off-by: shjones <[email protected]>

QDOCS-1060: fix build error

b87770d

Signed-off-by: shjones <[email protected]>

sheilamjones force-pushed the QDOCS-1060-docker branch from 54134b5 to b87770d Compare February 5, 2025 16:19

sheilamjones requested a review from rolfedh February 6, 2025 12:10

rolfedh reviewed Feb 7, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs: Create procedure for Deploying on OpenShift using Docker build strategy #45918

Docs: Create procedure for Deploying on OpenShift using Docker build strategy #45918

sheilamjones commented Jan 28, 2025 •

edited

Loading

quarkus-bot bot commented Jan 28, 2025

quarkus-bot bot commented Feb 5, 2025

github-actions bot commented Feb 5, 2025

sheilamjones commented Feb 5, 2025

rolfedh left a comment

rolfedh Feb 7, 2025

rolfedh Feb 7, 2025

rolfedh Feb 7, 2025

rolfedh Feb 7, 2025

rolfedh Feb 7, 2025

rolfedh Feb 7, 2025

rolfedh Feb 7, 2025

rolfedh Feb 7, 2025

rolfedh left a comment

rolfedh Feb 7, 2025

rolfedh Feb 7, 2025 •

edited

Loading

rolfedh Feb 7, 2025

rolfedh Feb 7, 2025

rolfedh Feb 7, 2025

rolfedh Feb 7, 2025

rolfedh Feb 7, 2025

rolfedh Feb 7, 2025

	The container gets built inside the {openshift} cluster and is provided as an image stream.
	The {openshift} cluster builds the container and provides it as an image stream.

	When you want to use a custom Dockerfile, you must add the file in the `src/main/docker` directory or anywhere inside the module. Additionally, you must set the path to your Dockerfile by using the `quarkus.openshift.jvm-dockerfile` property.
	If you want to use a custom Dockerfile, add the file to the `src/main/docker` directory or any location inside the module. Additionally, set the path to your Dockerfile by using the `quarkus.openshift.jvm-dockerfile` property.

	* You have access to a {openshift} cluster and the latest compatible version of the `oc` tool installed.
	* You have access to a {openshift} cluster and the latest compatible version of the `oc` CLI tool installed.

	. Optional: Set the following properties in the `application.properties` file, as required by your environment:
	. Optional: Set the following properties in the `application.properties` file based on your environment:

	.. If you are using an untrusted certificate, configure the `KubernetesClient`:
	** If you are using an untrusted certificate, enable certificate trust for the `KubernetesClient`:

	.. Expose the service to create an {openshift} route:
	** To expose the service and create an {openshift} route, set the following property:

	.. Set the path to your custom Dockerfile:
	** To use a custom Dockerfile instead of the pregenerated Dockerfiles, set the path to your Dockerfile:

	. Package and deploy your application to the current OpenShift project:
	. Package and deploy your application to the current {openshift} project:


		== Verification

		The verification steps and related terminal outputs are demonstrated on the `openshift-helloworld` example application.

	The verification steps and related terminal outputs are demonstrated on the `openshift-helloworld` example application.
	The following verification steps use the `openshift-helloworld` example application.

		. To retrieve the log output for your application's pod, use the `oc logs -f` command with the `<pod_name>` value of the pod you are interested in.
		In this example, we use the `openshift-helloworld-1-gzzrx` pod name that corresponds with the latest pod prefixed with the name of your application:

	. To retrieve the log output for your application's pod, use the `oc logs -f` command with the `<pod_name>` value of the pod you are interested in.
	In this example, we use the `openshift-helloworld-1-gzzrx` pod name that corresponds with the latest pod prefixed with the name of your application:
	. To get the log output for your application's pod, use the `oc logs -f` command with its name. For example:

	[source,shell,subs=attributes+]
	.Example output
	[source,shell,subs=attributes+]

	Be aware that the route is now listening on port 80 and no longer at port 8080.
	Be aware that the route is now listening on port 80.

Docs: Create procedure for Deploying on OpenShift using Docker build strategy #45918

Are you sure you want to change the base?

Docs: Create procedure for Deploying on OpenShift using Docker build strategy #45918

Conversation

sheilamjones commented Jan 28, 2025 • edited Loading

quarkus-bot bot commented Jan 28, 2025

quarkus-bot bot commented Feb 5, 2025

Status for workflow Quarkus Documentation CI

github-actions bot commented Feb 5, 2025

sheilamjones commented Feb 5, 2025

rolfedh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rolfedh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rolfedh Feb 7, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sheilamjones commented Jan 28, 2025 •

edited

Loading

Status for workflow `Quarkus Documentation CI`

rolfedh Feb 7, 2025 •

edited

Loading