Skip to content

Commit 467755d

Browse files
actions-useractions-user
committed
Sync documentation of main branch
1 parent f35c80b commit 467755d

File tree

6 files changed

+289
-1
lines changed

6 files changed

+289
-1
lines changed

‎_data/versioned/main/index/quarkus.yaml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -675,6 +675,12 @@ types:
675675
id: deploying-to-openshift-howto
676676
type: howto
677677
url: /guides/deploying-to-openshift-howto
678+
- title: "Deploy {project-name} applications compiled to native executables"
679+
filename: deploying-to-openshift-native-howto.adoc
680+
summary: "You can deploy your native {project-name} applications to {openshift} compiled to native executables by using the Docker build strategy."
681+
id: deploying-to-openshift-native-howto
682+
type: howto
683+
url: /guides/deploying-to-openshift-native-howto
678684
- title: Dev Services and Dev UI for OpenID Connect (OIDC)
679685
filename: security-openid-connect-dev-services.adoc
680686
summary: You can use Dev Services for Keycloak and the Dev UI for the OpenID Connect (OIDC) Keycloak provider and adapt these services for other OpenID Connect providers.

‎_generated-doc/main/config/quarkus-all-config.adoc‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21058,6 +21058,48 @@ endif::add-copy-button-to-env-var[]
2105821058
|string
2105921059
|
2106021060

21061+
a| [[quarkus-elytron-security-oauth2_quarkus-oauth2-connection-timeout]] [.property-path]##link:#quarkus-elytron-security-oauth2_quarkus-oauth2-connection-timeout[`quarkus.oauth2.connection-timeout`]##
21062+
ifdef::add-copy-button-to-config-props[]
21063+
config_property_copy_button:+++quarkus.oauth2.connection-timeout+++[]
21064+
endif::add-copy-button-to-config-props[]
21065+
21066+
21067+
[.description]
21068+
--
21069+
Client connection timeout for token introspection. Infinite if not set.
21070+
21071+
21072+
ifdef::add-copy-button-to-env-var[]
21073+
Environment variable: env_var_with_copy_button:+++QUARKUS_OAUTH2_CONNECTION_TIMEOUT+++[]
21074+
endif::add-copy-button-to-env-var[]
21075+
ifndef::add-copy-button-to-env-var[]
21076+
Environment variable: `+++QUARKUS_OAUTH2_CONNECTION_TIMEOUT+++`
21077+
endif::add-copy-button-to-env-var[]
21078+
--
21079+
|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]]
21080+
|
21081+
21082+
a| [[quarkus-elytron-security-oauth2_quarkus-oauth2-read-timeout]] [.property-path]##link:#quarkus-elytron-security-oauth2_quarkus-oauth2-read-timeout[`quarkus.oauth2.read-timeout`]##
21083+
ifdef::add-copy-button-to-config-props[]
21084+
config_property_copy_button:+++quarkus.oauth2.read-timeout+++[]
21085+
endif::add-copy-button-to-config-props[]
21086+
21087+
21088+
[.description]
21089+
--
21090+
Client read timeout for token introspection. Infinite if not set.
21091+
21092+
21093+
ifdef::add-copy-button-to-env-var[]
21094+
Environment variable: env_var_with_copy_button:+++QUARKUS_OAUTH2_READ_TIMEOUT+++[]
21095+
endif::add-copy-button-to-env-var[]
21096+
ifndef::add-copy-button-to-env-var[]
21097+
Environment variable: `+++QUARKUS_OAUTH2_READ_TIMEOUT+++`
21098+
endif::add-copy-button-to-env-var[]
21099+
--
21100+
|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]]
21101+
|
21102+
2106121103

2106221104
h|[.extension-name]##Elytron Security Properties File##
2106321105
h|Type

‎_generated-doc/main/config/quarkus-elytron-security-oauth2.adoc‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,5 +133,66 @@ endif::add-copy-button-to-env-var[]
133133
|string
134134
|
135135

136+
a| [[quarkus-elytron-security-oauth2_quarkus-oauth2-connection-timeout]] [.property-path]##link:#quarkus-elytron-security-oauth2_quarkus-oauth2-connection-timeout[`quarkus.oauth2.connection-timeout`]##
137+
ifdef::add-copy-button-to-config-props[]
138+
config_property_copy_button:+++quarkus.oauth2.connection-timeout+++[]
139+
endif::add-copy-button-to-config-props[]
140+
141+
142+
[.description]
143+
--
144+
Client connection timeout for token introspection. Infinite if not set.
145+
146+
147+
ifdef::add-copy-button-to-env-var[]
148+
Environment variable: env_var_with_copy_button:+++QUARKUS_OAUTH2_CONNECTION_TIMEOUT+++[]
149+
endif::add-copy-button-to-env-var[]
150+
ifndef::add-copy-button-to-env-var[]
151+
Environment variable: `+++QUARKUS_OAUTH2_CONNECTION_TIMEOUT+++`
152+
endif::add-copy-button-to-env-var[]
153+
--
154+
|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-elytron-security-oauth2_quarkus-oauth2[icon:question-circle[title=More information about the Duration format]]
155+
|
156+
157+
a| [[quarkus-elytron-security-oauth2_quarkus-oauth2-read-timeout]] [.property-path]##link:#quarkus-elytron-security-oauth2_quarkus-oauth2-read-timeout[`quarkus.oauth2.read-timeout`]##
158+
ifdef::add-copy-button-to-config-props[]
159+
config_property_copy_button:+++quarkus.oauth2.read-timeout+++[]
160+
endif::add-copy-button-to-config-props[]
161+
162+
163+
[.description]
164+
--
165+
Client read timeout for token introspection. Infinite if not set.
166+
167+
168+
ifdef::add-copy-button-to-env-var[]
169+
Environment variable: env_var_with_copy_button:+++QUARKUS_OAUTH2_READ_TIMEOUT+++[]
170+
endif::add-copy-button-to-env-var[]
171+
ifndef::add-copy-button-to-env-var[]
172+
Environment variable: `+++QUARKUS_OAUTH2_READ_TIMEOUT+++`
173+
endif::add-copy-button-to-env-var[]
174+
--
175+
|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-elytron-security-oauth2_quarkus-oauth2[icon:question-circle[title=More information about the Duration format]]
176+
|
177+
136178
|===
137179

180+
ifndef::no-duration-note[]
181+
[NOTE]
182+
[id=duration-note-anchor-quarkus-elytron-security-oauth2_quarkus-oauth2]
183+
.About the Duration format
184+
====
185+
To write duration values, use the standard `java.time.Duration` format.
186+
See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information.
187+
188+
You can also use a simplified format, starting with a number:
189+
190+
* If the value is only a number, it represents time in seconds.
191+
* If the value is a number followed by `ms`, it represents time in milliseconds.
192+
193+
In other cases, the simplified format is translated to the `java.time.Duration` format for parsing:
194+
195+
* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`.
196+
* If the value is a number followed by `d`, it is prefixed with `P`.
197+
====
198+
endif::no-duration-note[]

‎_generated-doc/main/config/quarkus-elytron-security-oauth2_quarkus.oauth2.adoc‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,5 +133,66 @@ endif::add-copy-button-to-env-var[]
133133
|string
134134
|
135135

136+
a| [[quarkus-elytron-security-oauth2_quarkus-oauth2-connection-timeout]] [.property-path]##link:#quarkus-elytron-security-oauth2_quarkus-oauth2-connection-timeout[`quarkus.oauth2.connection-timeout`]##
137+
ifdef::add-copy-button-to-config-props[]
138+
config_property_copy_button:+++quarkus.oauth2.connection-timeout+++[]
139+
endif::add-copy-button-to-config-props[]
140+
141+
142+
[.description]
143+
--
144+
Client connection timeout for token introspection. Infinite if not set.
145+
146+
147+
ifdef::add-copy-button-to-env-var[]
148+
Environment variable: env_var_with_copy_button:+++QUARKUS_OAUTH2_CONNECTION_TIMEOUT+++[]
149+
endif::add-copy-button-to-env-var[]
150+
ifndef::add-copy-button-to-env-var[]
151+
Environment variable: `+++QUARKUS_OAUTH2_CONNECTION_TIMEOUT+++`
152+
endif::add-copy-button-to-env-var[]
153+
--
154+
|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-elytron-security-oauth2_quarkus-oauth2[icon:question-circle[title=More information about the Duration format]]
155+
|
156+
157+
a| [[quarkus-elytron-security-oauth2_quarkus-oauth2-read-timeout]] [.property-path]##link:#quarkus-elytron-security-oauth2_quarkus-oauth2-read-timeout[`quarkus.oauth2.read-timeout`]##
158+
ifdef::add-copy-button-to-config-props[]
159+
config_property_copy_button:+++quarkus.oauth2.read-timeout+++[]
160+
endif::add-copy-button-to-config-props[]
161+
162+
163+
[.description]
164+
--
165+
Client read timeout for token introspection. Infinite if not set.
166+
167+
168+
ifdef::add-copy-button-to-env-var[]
169+
Environment variable: env_var_with_copy_button:+++QUARKUS_OAUTH2_READ_TIMEOUT+++[]
170+
endif::add-copy-button-to-env-var[]
171+
ifndef::add-copy-button-to-env-var[]
172+
Environment variable: `+++QUARKUS_OAUTH2_READ_TIMEOUT+++`
173+
endif::add-copy-button-to-env-var[]
174+
--
175+
|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-elytron-security-oauth2_quarkus-oauth2[icon:question-circle[title=More information about the Duration format]]
176+
|
177+
136178
|===
137179

180+
ifndef::no-duration-note[]
181+
[NOTE]
182+
[id=duration-note-anchor-quarkus-elytron-security-oauth2_quarkus-oauth2]
183+
.About the Duration format
184+
====
185+
To write duration values, use the standard `java.time.Duration` format.
186+
See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information.
187+
188+
You can also use a simplified format, starting with a number:
189+
190+
* If the value is only a number, it represents time in seconds.
191+
* If the value is a number followed by `ms`, it represents time in milliseconds.
192+
193+
In other cases, the simplified format is translated to the `java.time.Duration` format for parsing:
194+
195+
* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`.
196+
* If the value is a number followed by `d`, it is prefixed with `P`.
197+
====
198+
endif::no-duration-note[]

‎_versions/main/guides/deploying-to-openshift-native-howto.adoc‎

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
////
2+
This guide is maintained in the main Quarkus repository
3+
and pull requests should be submitted there:
4+
https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
5+
////
6+
[id="deploying-to-openshift-native-howto"]
7+
= Deploy {project-name} applications compiled to native executables
8+
9+
include::_attributes.adoc[]
10+
:diataxis-type: howto
11+
:categories: cloud, native
12+
:summary: This guide describes how to deploy a Quarkus application to {openshift} compiled to native executables.
13+
:topics: devops,kubernetes,openshift,cloud,deployment
14+
:extensions: io.quarkus:quarkus-openshift
15+
16+
You can deploy your native {project-name} applications to {openshift} compiled to native executables by using the Docker build strategy.
17+
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.
20+
21+
Your Quarkus project includes pregenerated Dockerfiles with instructions.
22+
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.
24+
25+
== Prerequisites
26+
27+
* You have a Linux AMD64 system or an Open Container Initiative (OCI) compatible container runtime, such as Podman or Docker.
28+
* You have a Quarkus Maven project that includes the `quarkus-openshift` extension.
29+
* You are working in the correct OpenShift project namespace.
30+
31+
== Procedure
32+
33+
. Set the Docker build strategy in your `application.properties` configuration file:
34+
+
35+
[source, properties]
36+
----
37+
quarkus.openshift.build-strategy=docker
38+
----
39+
. Enable container-based native builds:
40+
+
41+
[source,properties]
42+
----
43+
quarkus.native.container-build=true
44+
----
45+
. Optional: Set the following properties in the `application.properties` file based on your environment:
46+
** If you are using an untrusted certificate, enable certificate trust for the `KubernetesClient`:
47+
+
48+
[source,properties]
49+
----
50+
quarkus.kubernetes-client.trust-certs=true
51+
----
52+
** To expose the service and create an {openshift} route, set the following property:
53+
+
54+
[source,properties]
55+
----
56+
quarkus.openshift.route.expose=true
57+
----
58+
** To use a custom Dockerfile instead of the pregenerated Dockerfiles, set the path to your custom Dockerfile:
59+
+
60+
[source,properties,subs="attributes+,+quotes"]
61+
----
62+
quarkus.openshift.native-dockerfile=<path_to_your_dockerfile>
63+
----
64+
For example, to specify a custom Dockerfile named `Dockerfile.custom-native`:
65+
+
66+
[source,properties]
67+
----
68+
quarkus.openshift.native-dockerfile=src/main/docker/Dockerfile.custom-native
69+
----
70+
71+
** Specify the container engine:
72+
*** To build a native executable with Podman:
73+
+
74+
[source,properties]
75+
----
76+
quarkus.native.container-runtime=podman
77+
----
78+
*** To build a native executable with Docker:
79+
+
80+
[source,properties]
81+
----
82+
quarkus.native.container-runtime=docker
83+
----
84+
85+
. Finally, build the native executable, package, and deploy your application to {openshift}:
86+
+
87+
[source,shell,subs="attributes+,+quotes"]
88+
----
89+
./mvnw clean package -Pnative -Dquarkus.openshift.deploy=true
90+
----
91+
92+
== Verification
93+
94+
. Verify that an image stream and a service resource are created, and that the application is deployed.
95+
Use the {openshift} web console or the following {openshift} command-line interface (CLI) commands:
96+
+
97+
[source,shell,subs="attributes+,+quotes"]
98+
----
99+
oc get is <1>
100+
oc get pods <2>
101+
oc get svc <3>
102+
----
103+
<1> List the image streams created.
104+
<2> List the pods associated with your current OpenShift project.
105+
<3> List the Kubernetes services.
106+
107+
[start=2]
108+
. To get the log output for your application's pod, run the following command where `__<pod_name>__` is the name of the latest pod prefixed with the name of your application:
109+
+
110+
[source,shell,subs="attributes+,+quotes"]
111+
----
112+
oc logs -f __<pod_name>__
113+
----
114+
115+
== References
116+
117+
* xref:deploying-to-openshift.adoc[Deploying {project-name} applications to {openshift}]
118+

‎_versions/main/guides/rest-client.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ public interface ExtensionsService {
180180
181181
}
182182
----
183-
<1> Request query will include parameter with key `name`
183+
<1> @RestQuery will include parameter with key `name`
184184
<2> Each `Map` entry represents exactly one query parameter
185185
<3> `MultivaluedMap` allows you to send array values
186186

0 commit comments

Comments
 (0)