Skip to content

Commit 82d148a

Browse files
committed
QDOCS-1060: implemented peer review fixes
Signed-off-by: shjones <[email protected]>
1 parent f62997c commit 82d148a

File tree

1 file changed

+17
-21
lines changed

1 file changed

+17
-21
lines changed

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

Lines changed: 17 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,18 @@ include::_attributes.adoc[]
1515
As an application developer, you can deploy your applications to {openshift} by using the Docker build strategy as a deployment option.
1616
This functionality is provided by the `quarkus-openshift` extension.
1717

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

20-
Your Quarkus project includes pregenerated Dockerfiles with instructions.
21-
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.
20+
If you want to use a custom Dockerfile, add the file to the `src/main/docker` directory or any location inside the module.
21+
Additionally, set the path to your Dockerfile by using the `quarkus.openshift.jvm-dockerfile` property.
2222

2323
== Prerequisites
2424

2525
* You have OpenJDK {JDK-ver-all} installed.
2626
* You have set the `JAVA_HOME` environment variable to the location of the Java SDK.
2727
* You have Apache Maven {maven-version} installed.
2828
* You have a Quarkus project that includes the `quarkus-openshift` extension.
29-
* You have access to a {openshift} cluster and the latest compatible version of the `oc` tool installed.
29+
* You have access to a {openshift} cluster and the latest compatible version of the `oc` CLI tool installed.
3030
* You are working in the correct OpenShift project namespace.
3131

3232
== Procedure
@@ -37,33 +37,34 @@ When you want to use a custom Dockerfile, you must add the file in the `src/main
3737
----
3838
quarkus.openshift.build-strategy=docker
3939
----
40-
. Optional: Set the following properties in the `application.properties` file, as required by your environment:
41-
.. If you are using an untrusted certificate, configure the `KubernetesClient`:
40+
. Optional: Set the following properties in the `application.properties` file, based on your environment:
41+
** If you are using an untrusted certificate, enable certificate trust for the `KubernetesClient`:
4242
+
4343
[source,properties]
4444
----
4545
quarkus.kubernetes-client.trust-certs=true
4646
----
47-
.. Expose the service to create an {openshift} route:
47+
** To expose the service and create an {openshift} route, set the following property:
4848
+
4949
[source,properties]
5050
----
5151
quarkus.openshift.route.expose=true
5252
----
53-
.. Set the path to your custom Dockerfile:
53+
** To use a custom Dockerfile instead of the pregenerated Dockerfiles, set the path to your Dockerfile:
5454
+
5555
[source,properties,subs="attributes+,+quotes"]
5656
----
5757
quarkus.openshift.jvm-dockerfile=<path_to_your_dockerfile>
5858
----
59-
The following example shows the path to the `Dockerfile.custom-jvm`:
59+
+
60+
For example, to specify a custom Dockerfile named `Dockerfile.custom-jvm`:
6061
+
6162
[source,properties]
6263
----
6364
quarkus.openshift.jvm-dockerfile=src/main/resources/Dockerfile.custom-jvm
6465
----
6566

66-
. Package and deploy your application to the current OpenShift project:
67+
. Package and deploy your application to the current {openshift} project:
6768
+
6869
[source,shell,subs="attributes+,+quotes"]
6970
----
@@ -72,8 +73,7 @@ quarkus.openshift.jvm-dockerfile=src/main/resources/Dockerfile.custom-jvm
7273

7374
== Verification
7475

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

7878
. Display the list of pods associated with your current OpenShift project:
7979
+
@@ -90,8 +90,8 @@ openshift-helloworld-1-deploy 0/1 Completed 0 10m
9090
openshift-helloworld-1-gzzrx 1/1 Running 0 10m
9191
----
9292

93-
. 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.
94-
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:
93+
. To get the log output for your application's pod, use the `oc logs -f` command with its name.
94+
The following example uses the `openshift-helloworld-1-gzzrx` pod name, which corresponds to the latest pod prefixed with the name of your application:
9595
+
9696
[source,shell,subs="+quotes",options="nowrap"]
9797
----
@@ -111,7 +111,7 @@ __ ____ __ _____ ___ __ ____ ______
111111
2024-09-17 10:23:25,281 INFO [io.quarkus] (main) Installed features: [cdi, kubernetes, rest, smallrye-context-propagation, vertx]
112112
----
113113

114-
. Retrieve a list of services:
114+
. Get a list of services:
115115
+
116116
[source,shell,subs="+quotes",options="nowrap"]
117117
----
@@ -125,11 +125,7 @@ openshift-helloworld ClusterIP 172.30.64.57 <none> 80/TCP
125125
----
126126

127127
. Get a URL to test your application.
128-
+
129-
[NOTE]
130-
====
131-
To create an {openshift} route, ensure you have specified `quarkus.openshift.route.expose=true` in the `application.properties` file.
132-
====
128+
To do so, ensure you have exposed an {openshift} route by setting the `quarkus.openshift.route.expose=true` property in the `application.properties` file before building the application.
133129
+
134130
[source,shell,subs="+quotes",options="nowrap"]
135131
----
@@ -144,7 +140,7 @@ openshift-helloworld openshift-helloworld-username-dev.apps.sandbox-m2.ll9k.p1
144140
+
145141
[NOTE]
146142
====
147-
Be aware that the route is now listening on port 80 and no longer at port 8080.
143+
Be aware that the route is now listening on port 80 and is no longer on port 8080.
148144
====
149145
+
150146
You can test the application demonstrated in this example with a web browser or a terminal by using `curl` and the complete URL output from `oc get routes`, that is, "\http://openshift-helloworld-username-dev.apps.sandbox-m2.ll9k.p1.openshiftapps.com".

0 commit comments

Comments
 (0)