Skip to content

Commit 13a59bf

Browse files
authored
Merge pull request #1182 from gsmet/config-file-rename
Prepare the documentation for the config file rename
2 parents a8a0dba + eb19167 commit 13a59bf

9 files changed

+25
-25
lines changed

docs/src/main/asciidoc/extension-authors-guide.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ Configuration in Quarkus is based on SmallRye Config, an implementation of the M
163163
All of the standard features of MP-Config are supported; in addition, there are several extensions which are made available
164164
by the SmallRye Config project as well as by Quarkus itself.
165165

166-
The value of these properties is configured in a `META-INF/microprofile-config.properties` file that conforms to the MicroProfile config format.
166+
The value of these properties is configured in a `application.properties` file that follows the MicroProfile config format.
167167

168168
Configuration of Quarkus extensions is injection-based, using annotations.
169169

@@ -344,7 +344,7 @@ key type.
344344
<2> The `@ConfigRoot` annotation indicates that this object is a configuration root group, whose property names will have a parent only of `quarkus.`. In this case the properties within the group will begin with `quarkus.log.*`.
345345
<3> Here the `LoggingProcessor` injects a `LogConfiguration` instance automatically by detecting the `@ConfigRoot` annotation.
346346

347-
A corresponding `META-INF/microprofile-config.properties` file for the `File` values could be:
347+
A corresponding `application.properties` file for the `File` values could be:
348348
[source%nowrap,properties]
349349
----
350350
quarkus.log.file.enable=true
@@ -496,13 +496,13 @@ public class PersistenceAndQuarkusConfigTest {
496496
.setExpectedException(ConfigurationError.class) <1>
497497
.setArchiveProducer(() -> ShrinkWrap.create(JavaArchive.class)
498498
.addAsManifestResource("META-INF/some-persistence.xml", "persistence.xml")
499-
.addAsManifestResource("META-INF/microprofile-config.properties"));
499+
.addAsResource("application.properties"));
500500
501501
@Test
502502
public void testPersistenceAndConfigTest() {
503503
// should not be called, deployment exception should happen first:
504504
// it's illegal to have Hibernate configuration properties in both the
505-
// microprofile-config.properties an in the persistence.xml
505+
// application.properties and in the persistence.xml
506506
Assertions.fail();
507507
}
508508

docs/src/main/asciidoc/hibernate-orm-guide.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
= {project-name} - Using Hibernate ORM and JPA
2-
:config-file: microprofile-config.properties
2+
:config-file: application.properties
33

44
Hibernate ORM is the de facto JPA implementation and offers you the full breath of an Object Relational Mapper.
55
It works beautifully in {project-name}.

docs/src/main/asciidoc/infinispan-client-guide.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ This will add the following to your pom.xml
2525
</dependency>
2626
----
2727

28-
The Infinispan client is configurable in the `microprofile-config.properties` file that can be
29-
provided in the `META-INF` directory. These are the properties that
28+
The Infinispan client is configurable in the `application.properties` file that can be
29+
provided in the `src/main/resources` directory. These are the properties that
3030
can be configured in this file:
3131

3232
[cols=3*,options="header"]

docs/src/main/asciidoc/jwt-guide.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -265,12 +265,12 @@ Excellent, we have not provided any JWT in the request, so we should not be able
265265

266266
== Configuring the {extension-name} Extension Security Information
267267

268-
In the <<Configuration>> section we introduce the microprofile-config.properties that affect the {extension-name} extension.
268+
In the <<Configuration>> section we introduce the `application.properties` file that affect the {extension-name} extension.
269269

270-
=== Setting up microprofile-config.properties
271-
For part A of step 1, create a using-jwt-rbac/src/main/resources/META-INF/microprofile-config.properties with the following content:
270+
=== Setting up application.properties
271+
For part A of step 1, create a using-jwt-rbac/src/main/resources/application.properties with the following content:
272272

273-
.META-INF/microprofile-config.properties for TokenSecuredResource
273+
.application.properties for TokenSecuredResource
274274
[source, properties]
275275
----
276276
mp.jwt.verify.publickey.location=publicKey.pem #<1>

docs/src/main/asciidoc/native-and-ssl-guide.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The project is located in the `rest-client` {quickstarts-tree-url}/rest-client[d
2424

2525
== Looks like it works out of the box?!?
2626

27-
If you open the application's configuration file (`src/main/resources/META-INF/microprofile-config.properties`), you can see the following line:
27+
If you open the application's configuration file (`src/main/resources/application.properties`), you can see the following line:
2828
```
2929
org.acme.restclient.CountriesService/mp-rest/url=https://restcountries.eu/rest
3030
```
@@ -78,7 +78,7 @@ So if you are sure you don't need it, you can disable it entirely.
7878

7979
First, let's disable it without changing the REST service URL and see how it goes.
8080

81-
Open `src/main/resources/META-INF/microprofile-config.properties` and add the following line:
81+
Open `src/main/resources/application.properties` and add the following line:
8282
```
8383
quarkus.ssl.native=false
8484
```
@@ -95,7 +95,7 @@ Exception handling request to /country/name/greece: com.oracle.svm.core.jdk.Unsu
9595

9696
This error is the one you obtain when trying to use SSL while it was not explicitly enabled in your native image.
9797

98-
Now, let's change the REST service URL to **not** use SSL in `src/main/resources/META-INF/microprofile-config.properties`:
98+
Now, let's change the REST service URL to **not** use SSL in `src/main/resources/application.properties`:
9999
```
100100
org.acme.restclient.CountriesService/mp-rest/url=http://restcountries.eu/rest
101101
```
@@ -132,7 +132,7 @@ And there's more to it.
132132

133133
Let's revert the changes we made to the configuration file and go back to SSL with the following command:
134134
```
135-
git checkout -- src/main/resources/META-INF/microprofile-config.properties
135+
git checkout -- src/main/resources/application.properties
136136
```
137137

138138
And let's build the native image again:

docs/src/main/asciidoc/panache-jpa-guide.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
= {project-name} - Simplified Hibernate ORM and JPA with Panache
2-
:config-file: microprofile-config.properties
2+
:config-file: application.properties
33

44
Hibernate ORM is the de facto JPA implementation and offers you the full breadth of an Object Relational Mapper.
55
It makes complex mappings possible, but it does not make simple and common mappings trivial.

docs/src/main/asciidoc/rest-client-guide.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ It will allow to narrow down the number of JAX-RS providers (which can be seen a
172172

173173
== Create the configuration
174174

175-
In order to determine the base URL to which REST calls will be made, the REST Client uses configuration from `META-INF/microprofile-config.properties`.
175+
In order to determine the base URL to which REST calls will be made, the REST Client uses configuration from `application.properties`.
176176
The name of the property needs to follow a certain convention which is best displayed in the following code:
177177

178178
[source]

docs/src/main/asciidoc/security-guide.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ The property files realm supports mapping of users to password and users to role
8585
|quarkus.security.file.roles|roles.properties|Classpath resource name of properties file containing user to role mappings; see <<Roles.properties>>
8686
|===
8787

88-
.example microprofile-config.properties file section for property files realm
88+
.example application.properties file section for property files realm
8989
[source,properties]
9090
--
9191
quarkus.security.file.enabled=true
@@ -127,7 +127,7 @@ noadmin=user
127127
Given these role mappings, only user `scott` would be allowed to access the `/subject/secured` endpoint from the <<SubjectExposingResource Example>>.
128128

129129
### Embedded Realm Configuration
130-
The embedded realm also supports mapping of users to password and users to roles. It uses the main microprofile-config.properties Quarkus configuration file to embed this information. To enable and configure it, the following configuration properties are used:
130+
The embedded realm also supports mapping of users to password and users to roles. It uses the main application.properties Quarkus configuration file to embed this information. To enable and configure it, the following configuration properties are used:
131131

132132
|===
133133
|Property Name|Default|Description
@@ -138,9 +138,9 @@ The embedded realm also supports mapping of users to password and users to roles
138138
|quarkus.security.embedded.roles.*|none|Prefix for the properties that specify user to role mappings; see <<Embedded Roles>>
139139
|===
140140

141-
The following is an example microprofile-config.properties file section illustrating the embedded realm configuration:
141+
The following is an example application.properties file section illustrating the embedded realm configuration:
142142

143-
.example microprofile-config.properties file section for embedded realm
143+
.example application.properties file section for embedded realm
144144
[source,properties]
145145
----
146146
quarkus.security.embedded.enabled=true
@@ -156,7 +156,7 @@ quarkus.security.embedded.auth-mechanism=CUSTOM
156156
----
157157

158158
#### Embedded Users
159-
The user to password mappings are specified in the microprofile-config.properties by property names of the form `quarkus.security.embedded.users.<user>=<password>`. The following <<Example Passwords>> illustrates the syntax with the 4 user to password mappings shown in lines 2-5:
159+
The user to password mappings are specified in the `application.properties` file by property names of the form `quarkus.security.embedded.users.<user>=<password>`. The following <<Example Passwords>> illustrates the syntax with the 4 user to password mappings shown in lines 2-5:
160160

161161
.Example Passwords
162162
[source,properties,linenums,highlight='2-5']
@@ -175,7 +175,7 @@ quarkus.security.embedded.roles.noadmin=user
175175
<2> User `stuart` has password `test`
176176

177177
#### Embedded Roles
178-
The user to role mappings are specified in the microprofile-config.properties by property names of the form `quarkus.security.embedded.roles.<user>=role1[,role2[,role3[,...]]]`. The following <<Example Roles>> illustrates the syntax with the 4 user to role mappings shown in lines 6-9:
178+
The user to role mappings are specified in the `application.properties` file by property names of the form `quarkus.security.embedded.roles.<user>=role1[,role2[,role3[,...]]]`. The following <<Example Roles>> illustrates the syntax with the 4 user to role mappings shown in lines 6-9:
179179

180180
.Example Roles
181181
[source,properties,linenums,highlight='6-9']

docs/src/main/asciidoc/spring-di-guide.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ public class NoOpSingleStringFunction implements StringFunction {
119119
----
120120

121121
{project-name} also provides support for injecting configuration values using Spring's `@Value` annotation.
122-
To see that in action, first edit the `src/main/resources/META-INF/microprofile-config.properties` with the following content:
122+
To see that in action, first edit the `src/main/resources/application.properties` with the following content:
123123

124124
[source]
125125
----
@@ -189,7 +189,7 @@ public class GreeterBean {
189189
----
190190

191191
In the code above, we see that both field injection and constructor injection are being used (note that constructor injection does not need the `@Autowired` annotation since there is a single constructor).
192-
Furthermore, the `@Value` annotation on `suffix` has also a default value defined, which in this case will be used since we have not defined `greeting.suffix` in `microprofile-config.properties`.
192+
Furthermore, the `@Value` annotation on `suffix` has also a default value defined, which in this case will be used since we have not defined `greeting.suffix` in `application.properties`.
193193

194194

195195
=== Update the JAX-RS resource

0 commit comments

Comments
 (0)