Skip to content

Commit ecfd585

Browse files
authored
Merge pull request quarkusio#47408 from sheilamjones/QDOCS-1031-implement-QE-feedback
Docs: Implement QE feedback to Deploying to OpenShift guide
2 parents 17478be + 9eb6ef3 commit ecfd585

5 files changed

+29
-22
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ 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 a Docker build strategy
7+
= Deploying {project-name} Java applications to {openshift} by using a Docker build strategy
88
include::_attributes.adoc[]
99
:diataxis-type: howto
1010
:categories: cloud, native

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ 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-howto"]
7-
= Deploy {project-name} applications to {openshift} in a single step
7+
= Deploying {project-name} applications to {openshift} in a single step
88
include::_attributes.adoc[]
99
:diataxis-type: howto
1010
:categories: cloud, native
@@ -35,7 +35,7 @@ The generated resources use a Kubernetes `Deployment`, but still make use of Ope
3535
To run this deployment, it is not necessary to have the `quarkus-openshift` extension included in your {project-name} project.
3636
====
3737

38-
== Build and deploy in a single step
38+
== Procedure
3939

4040
. Trigger a build and deployment in a single step:
4141

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

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@ 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-native-howto"]
7-
= Deploy {project-name} applications compiled to native executables
8-
7+
= Deploying {project-name} applications compiled to native executables
98
include::_attributes.adoc[]
109
:diataxis-type: howto
1110
:categories: cloud, native
@@ -15,17 +14,23 @@ include::_attributes.adoc[]
1514

1615
You can deploy your native {project-name} applications to {openshift} compiled to native executables by using the Docker build strategy.
1716

18-
You must create a native executable for your application that targets the Linux AMD64 operating system.
19-
If your host operating system is different from this, create a native Linux executable by using a container runtime, for example, Docker or Podman.
17+
You must create a native executable for your application that targets a supported operating system and match the architecture.
18+
This means, if you are building on Windows, you create a native Linux executable by using a container runtime, for example, Docker or Podman.
2019

2120
Your Quarkus project includes pregenerated Dockerfiles with instructions.
2221
If you want to use a custom Dockerfile, add the file to the `src/main/docker` directory or any location inside the module.
23-
Additionally, set the path to your Dockerfile by using the `quarkus.openshift.native-dockerfile` property.
22+
Additionally, if you want to have multiple Docker files and switch between them, set the path to your preferred Dockerfile by using the `quarkus.openshift.native-dockerfile` property.
23+
24+
[NOTE]
25+
====
26+
This guide describes this strategy by using a Quarkus project with Maven as the example project.
27+
====
2428

2529
== Prerequisites
2630

27-
* You have a Linux AMD64 system or an Open Container Initiative (OCI) compatible container runtime, such as Podman or Docker.
31+
* A supported operating system or an Open Container Initiative (OCI) compatible container runtime, such as Podman or Docker.
2832
* You have a Quarkus Maven project that includes the `quarkus-openshift` extension.
33+
* You have access to an {openshift} cluster and the latest compatible version of the `oc` CLI tool installed.
2934
* You are working in the correct OpenShift project namespace.
3035

3136
== Procedure

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ For more information, see the link:https://docs.openshift.com/container-platform
183183
For information about this image, see link:https://catalog.redhat.com/software/containers/ubi9/openjdk-21/653fb7e21b2ec10f7dfc10d0[{runtimes-openjdk-long} 21].
184184
====
185185

186-
. To build the project, create the application, and deploy the {openshift} service, enter the following command:
186+
. Build the project, create the application, and deploy the {openshift} service:
187187
+
188188
[source,xml,subs="attributes+,+quotes"]
189189
----

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

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ This guide is maintained in the main Quarkus repository
33
and pull requests should be submitted there:
44
https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
55
////
6-
[id="deploy-openshift"]
6+
[id="deploying-to-openshift"]
77
= Deploying {project-name} applications to {openshift}
88
include::_attributes.adoc[]
99
:categories: cloud, native
@@ -107,9 +107,10 @@ However, if you want to continue to use `DeploymentConfig`, it is still possible
107107
quarkus extension add 'quarkus-openshift'
108108
----
109109

110-
== Logging in to an OpenShift cluster
110+
== Logging in to an {openshift} cluster
111111

112-
You can log in to an OpenShift cluster by using the https://docs.openshift.com/container-platform/4.9/cli_reference/openshift_cli/getting-started-cli.html[OpenShift CLI]:
112+
You can log in to an {openshift} cluster by using the OpenShift CLI (`oc`).
113+
For more information, see link:https://docs.openshift.com/container-platform/4.18/cli_reference/openshift_cli/getting-started-cli.html[Getting started with the OpenShift CLI]:
113114

114115
.Example: Log in by using the OpenShift CLI
115116
[source,bash]
@@ -120,7 +121,7 @@ oc login -u myUsername <1>
120121

121122
Alternatively, you can log in by using the API token:
122123

123-
.Example: Log in by using the OpenShift command-line interface (CLI) with API token
124+
.Example: Log in by using the OpenShift CLI with API token
124125
[source,bash]
125126
----
126127
oc login --token=myToken --server=myServerUrl
@@ -326,12 +327,12 @@ quarkus.openshift.annotations.foo=bar
326327
[[env-vars]]
327328
=== Environment variables
328329

329-
OpenShift provides multiple ways of defining environment variables:
330+
{openshift} provides multiple ways of defining environment variables:
330331

331-
- key/value pairs
332-
- import all values from a Secret or ConfigMap
333-
- interpolate a single value identified by a given field in a Secret or ConfigMap
334-
- interpolate a value from a field within the same resource
332+
- Key/value pairs
333+
- Import all values from a Secret or ConfigMap
334+
- Interpolate a single value identified by a given field in a Secret or ConfigMap
335+
- Interpolate a value from a field within the same resource
335336

336337
==== Environment variables from key/value pairs
337338

@@ -467,7 +468,8 @@ For example, adding the property `quarkus.openshift.arguments=A,B`.
467468
Finally, the Kubernetes job will be launched every time that it is installed in OpenShift.
468469
For more information about how to run Kubernetes jobs, see https://kubernetes.io/docs/concepts/workloads/controllers/job/#running-an-example-job[Running an example job].
469470

470-
You can configure the rest of the Kubernetes Job configuration by using the properties under `quarkus.openshift.job.xxx` (for more information, see xref:deploying-to-openshift.adoc#quarkus-kubernetes_quarkus-openshift-job-parallelism[quarkus.openshift.job.parallelism).
471+
You can configure the rest of the Kubernetes Job configuration by using the properties under `quarkus.openshift.job.xxx`.
472+
For more information, see xref:deploying-to-openshift.adoc#quarkus-kubernetes_quarkus-openshift-job-parallelism[quarkus.openshift.job.parallelism].
471473

472474
===== Generating CronJob resources
473475

@@ -513,13 +515,13 @@ The older syntax is still supported but is deprecated, and it is advised that yo
513515

514516
[NOTE]
515517
====
516-
If you redefine the same variable using the new syntax while keeping the old syntax, **ONLY** the new version is kept, and a warning will be issued to alert you of the problem.
518+
If you redefine the same variable by using the new syntax while keeping the old syntax, only the new version is kept, and a warning will be issued to alert you of the problem.
517519
For example, if you define both `quarkus.openshift.env-vars.my-env-var.value=foobar` and `quarkus.openshift.env.vars.my-env-var=newValue`, the extension generates an environment variable `MY_ENV_VAR=newValue` and issues a warning.
518520
====
519521

520522
=== Mounting volumes
521523

522-
The OpenShift extension allows the user to configure both volumes and mounts for the application.
524+
The OpenShift extension allows you to configure both volumes and mounts for the application.
523525
You can mount any volume with a simple configuration:
524526

525527
[source,properties]

0 commit comments

Comments
 (0)