Skip to content

Commit 54134b5

Browse files
committed
QDOCS-1060: fix attribtes and minor edits
Signed-off-by: shjones <[email protected]>
1 parent 753686d commit 54134b5

File tree

1 file changed

+15
-20
lines changed

1 file changed

+15
-20
lines changed

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

Lines changed: 15 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,31 @@ and pull requests should be submitted there:
44
https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
55
////
66
[id="deploying-to-openshift-docker-howto"]
7-
= Deploy {project-name} Java applications to OpenShift by using Docker build
7+
= Deploy {project-name} Java applications to {openshift} by using a Docker build strategy
88
include::_attributes.adoc[]
99
:diataxis-type: howto
1010
:categories: cloud, native
11-
:summary: This guide covers how to build and deploy a Quarkus application on OpenShift by using Docker builds.
11+
:summary: This guide describes how to build and deploy a Quarkus application on {openshift} by using the Docker build strategy.
1212
:topics: devops,kubernetes,openshift,cloud,deployment
1313
:extensions: io.quarkus:quarkus-openshift
1414

15-
This guide describes how to deploy {project-name} applications to OpenShift by using Docker build.
15+
As an application developer, you can deploy your applications to {openshift} by using the Docker build strategy as a deployment option.
16+
This functionality is provided by the `quarkus-openshift` extension.
1617

17-
As an application developer, you can deploy your Quarkus applications to OpenShift by using the Docker build strategy as a deployment option.
18-
This functionality is provided by the `quarkus-openshift` extension, which supports multiple deployment options, including the Docker build strategy and the Source-to-Image (S2I) strategy.
18+
The container gets built inside the {openshift} cluster and is provided as an image stream.
19+
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.
1922

2023
== Prerequisites
2124

22-
* You have OpenJDK 17 or later installed.
25+
* You have OpenJDK {JDK-ver-all} installed.
2326
* You have set the `JAVA_HOME` environment variable to the location of the Java SDK.
2427
* You have Apache Maven {maven-version} installed.
2528
* You have a Quarkus project that includes the `quarkus-openshift` extension.
2629
//** To add the Quarkus OpenShift extension, see xref:proc_adding-the-quarkus-openshift-extension_quarkus-openshift[Adding the {ProductName} OpenShift extension].
27-
* You have access to an OpenShift cluster and the latest compatible version of the `oc` tool installed.
30+
* You have access to a {openshift} cluster and the latest compatible version of the `oc` tool installed.
31+
* You are working in the correct OpenShift project namespace.
2832

2933
== Procedure
3034

@@ -41,7 +45,7 @@ quarkus.openshift.build-strategy=docker
4145
----
4246
quarkus.kubernetes-client.trust-certs=true
4347
----
44-
.. Expose the service to create an {RHOSSHORT} route:
48+
.. Expose the service to create an {openshift} route:
4549
+
4650
[source,properties]
4751
----
@@ -60,18 +64,15 @@ The following example shows the path to the `Dockerfile.custom-jvm`:
6064
quarkus.openshift.jvm-dockerfile=src/main/resources/Dockerfile.custom-jvm
6165
----
6266

63-
64-
. Package and deploy your Quarkus application to the current OpenShift project:
67+
. Package and deploy your application to the current OpenShift project:
6568
+
6669
[source,shell,subs="attributes+,+quotes"]
6770
----
6871
./mvnw clean package -Dquarkus.openshift.deploy=true
6972
----
7073

71-
7274
== Verification
7375

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

7778

@@ -90,9 +91,6 @@ openshift-helloworld-1-deploy 0/1 Completed 0 10m
9091
openshift-helloworld-1-gzzrx 1/1 Running 0 10m
9192
----
9293

93-
94-
95-
9694
. 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.
9795
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:
9896
+
@@ -109,7 +107,7 @@ __ ____ __ _____ ___ __ ____ ______
109107
--/ __ \/ / / / _ | / _ \/ //_/ / / / __/
110108
-/ /_/ / /_/ / __ |/ , _/ ,< / /_/ /\ \
111109
--\___\_\____/_/ |_/_/|_/_/|_|\____/___/
112-
2024-09-17 10:23:25,254 INFO [io.quarkus] (main) getting-started 1.0.0-SNAPSHOT on JVM (powered by Quarkus {QuarkusCore}) started in 0.653s. Listening on: http://0.0.0.0:8080
110+
2024-09-17 10:23:25,254 INFO [io.quarkus] (main) getting-started 1.0.0-SNAPSHOT on JVM (powered by Quarkus {QuarkusCore}) started in 0.653s. Listening on: http://0.0.0.0:8080
113111
2024-09-17 10:23:25,281 INFO [io.quarkus] (main) Profile prod activated.
114112
2024-09-17 10:23:25,281 INFO [io.quarkus] (main) Installed features: [cdi, kubernetes, rest, smallrye-context-propagation, vertx]
115113
----
@@ -131,7 +129,7 @@ openshift-helloworld ClusterIP 172.30.64.57 <none> 80/TCP
131129
+
132130
[NOTE]
133131
====
134-
To create an {RHOSSHORT} route, ensure you have specified `quarkus.openshift.route.expose=true` in the `application.properties` file.
132+
To create an {openshift} route, ensure you have specified `quarkus.openshift.route.expose=true` in the `application.properties` file.
135133
====
136134
+
137135
[source,shell,subs="+quotes",options="nowrap"]
@@ -155,6 +153,3 @@ You can test the application demonstrated in this example with a web browser or
155153
For example: `curl \http://openshift-helloworld-username-dev.apps.sandbox-m2.ll9k.p1.openshiftapps.com`.
156154

157155

158-
== Configuration Reference
159-
160-
include::{generated-dir}/config/quarkus-kubernetes_quarkus.openshift.adoc[opts=optional, leveloffset=+1]

0 commit comments

Comments
 (0)