-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Jetty 12.0.x document modules (#9151)
* Add documentation in "Standard Modules" section for the jmx module * Add documentation in "Standard Modules" section for the ee8,9,10-webapp modules * Use shorter markup tags to transclude documentation from .mod files * Extract EE version strings into variables * Replace literal usages of EE version numbers with custom attribute * Use convention 'eeN' instead of 'eex' in filenames * Update metadata tag for deploy module documentation * Update deploy module documentation to discuss EE platform-specific deploy modules * Add documentation for the resources module * Add resources module into section table of contents * Use jetty-home instead of JETTY_HOME as documentation attribute Co-authored-by: Simone Bordet <[email protected]>
- Loading branch information
1 parent
fc762ae
commit 06efbca
Showing
22 changed files
with
179 additions
and
92 deletions.
There are no files selected for viewing
3 changes: 3 additions & 0 deletions
3
documentation/jetty-documentation/src/main/asciidoc/operations-guide/.asciidoctorconfig
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,8 @@ | ||
| // Asciidoctor IDE configuration file. | ||
| // See https://github.com/asciidoctor/asciidoctor-intellij-plugin/wiki/Support-project-specific-configurations | ||
| :ee-all: ee{8,9,10} | ||
| :ee-current: ee10 | ||
| :ee-current-caps: EE10 | ||
| :experimental: | ||
| :imagesdir: images | ||
| :jetty-home: ../../../../../../../jetty-home/target/jetty-home |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
33 changes: 0 additions & 33 deletions
33
...tty-documentation/src/main/asciidoc/operations-guide/modules/module-deploy.adoc
This file was deleted.
Oops, something went wrong.
38 changes: 38 additions & 0 deletions
38
...documentation/src/main/asciidoc/operations-guide/modules/module-eeN-deploy.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| // | ||
| // ======================================================================== | ||
| // Copyright (c) 1995-2022 Mort Bay Consulting Pty Ltd and others. | ||
| // | ||
| // This program and the accompanying materials are made available under the | ||
| // terms of the Eclipse Public License v. 2.0 which is available at | ||
| // https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0 | ||
| // which is available at https://www.apache.org/licenses/LICENSE-2.0. | ||
| // | ||
| // SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 | ||
| // ======================================================================== | ||
| // | ||
|
|
||
| [[og-module-eeN-deploy]] | ||
| ===== Module `{ee-all}-deploy` | ||
|
|
||
| include::{jetty-home}/modules/{ee-current}-deploy.mod[tags=description] | ||
|
|
||
| Deployment is managed via a `DeploymentManager` component that watches a directory for changes. | ||
| See xref:og-deploy[how to deploy web applications] for more information. | ||
|
|
||
| Adding files or directories to this monitored directory will cause the `DeploymentManager` to deploy them as web applications; updating files already existing in this monitored directory will cause the `DeploymentManager` to re-deploy the corresponding web application; removing files in this monitored directory will cause the `DeploymentManager` to "undeploy" the corresponding web application. | ||
| (You can find a more detailed discussion of these rules in the xref:og-deploy-rules[deployment rules] section.) | ||
|
|
||
| Multiple versions of this module exist (`{ee-all}-deploy`) to support each Jakarta EE platform's version of the Java Servlet specification. | ||
| Jetty's configuration properties are nearly identical across these versions; the configuration properties for the `{ee-current}-deploy` Jetty module are: | ||
|
|
||
| ---- | ||
| include::{jetty-home}/modules/{ee-current}-deploy.mod[tags=ini-template] | ||
| ---- | ||
|
|
||
| Among the configurable properties, the most relevant are: | ||
|
|
||
| `jetty.deploy.monitoredDir`:: | ||
| The name of the monitored directory. | ||
| `jetty.deploy.scanInterval`:: | ||
| The scan period in seconds, that is how frequently the `DeploymentManager` wakes up to scan the monitored directory for changes. | ||
| Setting `jetty.deploy.scanInterval=0` disabled _hot_ deployment so that only static deployment will be possible (see also xref:og-deploy-hot-static[here] for more information). |
24 changes: 24 additions & 0 deletions
24
...documentation/src/main/asciidoc/operations-guide/modules/module-eeN-webapp.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| // | ||
| // ======================================================================== | ||
| // Copyright (c) 1995-2022 Mort Bay Consulting Pty Ltd and others. | ||
| // | ||
| // This program and the accompanying materials are made available under the | ||
| // terms of the Eclipse Public License v. 2.0 which is available at | ||
| // https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0 | ||
| // which is available at https://www.apache.org/licenses/LICENSE-2.0. | ||
| // | ||
| // SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 | ||
| // ======================================================================== | ||
| // | ||
|
|
||
| [[og-module-eeN-webapp]] | ||
| ===== Module `{ee-all}-webapp` | ||
|
|
||
| include::{jetty-home}/modules/{ee-current}-webapp.mod[tags=description] | ||
|
|
||
| Multiple versions of this module exist (`{ee-all}-webapp`) to support each Jakarta EE platform's version of the Java Servlet specification. | ||
| Jetty's configuration properties are identical across all versions of this module, and are as follows: | ||
|
|
||
| ---- | ||
| include::{jetty-home}/modules/{ee-current}-webapp.mod[tags=ini-template] | ||
| ---- |
20 changes: 20 additions & 0 deletions
20
.../jetty-documentation/src/main/asciidoc/operations-guide/modules/module-jmx.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| // | ||
| // ======================================================================== | ||
| // Copyright (c) 1995-2022 Mort Bay Consulting Pty Ltd and others. | ||
| // | ||
| // This program and the accompanying materials are made available under the | ||
| // terms of the Eclipse Public License v. 2.0 which is available at | ||
| // https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0 | ||
| // which is available at https://www.apache.org/licenses/LICENSE-2.0. | ||
| // | ||
| // SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 | ||
| // ======================================================================== | ||
| // | ||
|
|
||
| [[og-module-jmx]] | ||
| ===== Module `jmx` | ||
|
|
||
| include::{jetty-home}/modules/{ee-current}-webapp.mod[tags=description] | ||
|
|
||
| This configuration is useful for xref:og-jmx-local[local development and testing]. | ||
| If you need to xref:og-jmx-remote[enable remote access], use the xref:og-jmx-remote[`jmx-remote` module]. |
22 changes: 22 additions & 0 deletions
22
...-documentation/src/main/asciidoc/operations-guide/modules/module-resources.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| // | ||
| // ======================================================================== | ||
| // Copyright (c) 1995-2022 Mort Bay Consulting Pty Ltd and others. | ||
| // | ||
| // This program and the accompanying materials are made available under the | ||
| // terms of the Eclipse Public License v. 2.0 which is available at | ||
| // https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0 | ||
| // which is available at https://www.apache.org/licenses/LICENSE-2.0. | ||
| // | ||
| // SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 | ||
| // ======================================================================== | ||
| // | ||
|
|
||
| [[og-module-resources]] | ||
| ===== Module `resources` | ||
|
|
||
| include::{jetty-home}/modules/resources.mod[tags=description] | ||
|
|
||
| A common use-case for this module is to provide resources for third-party libraries via the xref:og-start-start-class-path[server classpath]. | ||
| For instance, many logging libraries (including https://logging.apache.org/log4j/2.x/[Log4j2] and https://logback.qos.ch/[Logback]) look for their configuration files on the classpath. | ||
|
|
||
| Jetty provides a logging library implementation -- enabled via the `logging-jetty` module -- whose configuration file is `$JETTY_BASE/resources/jetty-logging.properties`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,15 @@ | ||
| [description] | ||
| Enables web application deployment from the $JETTY_BASE/webapps/ directory. | ||
| This module enables web application deployment from the `$JETTY_BASE/webapps` directory. | ||
|
|
||
| [depend] | ||
| server | ||
|
|
||
| [lib] | ||
| lib/jetty-deploy-${jetty.version}.jar | ||
|
|
||
| [files] | ||
| webapps/ | ||
|
|
||
| [xml] | ||
| etc/jetty-deploy.xml | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.