Documented the new web application deployer. #13084
Conversation
Signed-off-by: Simone Bordet <[email protected]>
documentation/jetty/modules/operations-guide/pages/modules/standard.adoc
Outdated
Show resolved
Hide resolved
| @@ -1,5 +1,6 @@ | |||
| [description] | |||
| This module enables the direct Deployer, which simply adds and starts a context. | |||
| This module enables the standard Deployer, which adds and starts ContextHandler | |||
| instances produced by the deployment-scanner module. | |||
There was a problem hiding this comment.
| instances produced by the deployment-scanner module. | |
| instances. This module is used by the deployment-scanner module to deploy the web applications it discovers. |
There was a problem hiding this comment.
I like it less. The fact that ContextHandler instances are produced by deployment-scanner is lost in your proposal.
| @@ -19,4 +20,4 @@ etc/jetty-deployer-standard.xml | |||
| [ini-template] | |||
|
|
|||
| ## Should redeploys be atomic (may have two instances running simultaneously) | |||
There was a problem hiding this comment.
| ## Should redeploys be atomic (may have two instances running simultaneously) | |
| ## Atomic redeploy. A new instance is started and exchanged with the current, before the current is stopped. |
There was a problem hiding this comment.
Wrote an alternative which should be better.
| @@ -1,5 +1,5 @@ | |||
| [description] | |||
| This module enables web application context scanning of the `$JETTY_BASE/webapps` directory. | |||
| This module enables scanning of the `$JETTY_BASE/webapps` directory to deploy web applications. | |||
There was a problem hiding this comment.
| This module enables scanning of the `$JETTY_BASE/webapps` directory to deploy web applications. | |
| This module enables scanning of the `$JETTY_BASE/webapps` directory to deploy web applications discovered in the scanned deployment directory. |
There was a problem hiding this comment.
Wrote a shorter alternative to your proposal.
| # tag::description[] | ||
| Scans and deploys `static` content from `$JETTY_BASE/webapps/` directory. | ||
| # end::description[] | ||
| Scans and deploys Jetty `static` environment web applications. |
There was a problem hiding this comment.
static doesn't really deploy applications, at least not in our sense of the word
| Scans and deploys Jetty `static` environment web applications. | |
| Scans and deploys directories that are to be served statically by Jetty. |
There was a problem hiding this comment.
@gregw it actually does deploy a web application, in our sense of a ContextHandler being made available, with a contextPath, etc.
Users won't be able to figure out whether it is static files or generated by the servlet, so they will think they hit a web application deployed on the server.
documentation/jetty/modules/operations-guide/pages/modules/standard.adoc
Outdated
Show resolved
Hide resolved
| @@ -1,5 +1,6 @@ | |||
| [description] | |||
| This module enables the direct Deployer, which simply adds and starts a context. | |||
| This module enables the standard Deployer, which adds and starts ContextHandler | |||
There was a problem hiding this comment.
Huh? What is the deployer-standard module? How is this different to the deployment-scanner module? Shouldn't we have just one deployer module, and if users want something different they come up with their own module that configures their own Scanner etc.
There was a problem hiding this comment.
@janbartel deployer-scanner scans and creates the ContextHandler (subclass); deployer-standard links that ContextHandler to the server.
Before linking it to the server, another module may decorate it or reconfigure it.
| @@ -13,108 +13,258 @@ | |||
|
|
|||
| = Web Application Deployment | |||
|
|
|||
| The Jetty Web Application Deployment mechanism provides for: | |||
| The Jetty server deploys each web application to a specific _environment_. | |||
There was a problem hiding this comment.
| The Jetty server deploys each web application to a specific _environment_. | |
| Jetty deploys each web application to a specific _environment_. |
There was a problem hiding this comment.
Ah, no. "Jetty" is not defined (typically refers to the project), we have client and server, so it's really "The Jetty server".
documentation/jetty/modules/operations-guide/pages/deploy/index.adoc
Outdated
Show resolved
Hide resolved
documentation/jetty/modules/operations-guide/pages/deploy/index.adoc
Outdated
Show resolved
Hide resolved
documentation/jetty/modules/operations-guide/pages/deploy/index.adoc
Outdated
Show resolved
Hide resolved
documentation/jetty/modules/operations-guide/pages/deploy/index.adoc
Outdated
Show resolved
Hide resolved
| ---- | ||
|
|
||
| The contents of the `$JETTY_BASE/etc/{ee-current}-context.xml` then `$JETTY_BASE/etc/{ee-current}-feature.xml` files will be applied to the `wiki` webapp instance _before_ `wiki.xml`, allowing the contents of the latter to override the contents of the former. | ||
| [[jetty-web-xml]] |
There was a problem hiding this comment.
I wouldn't document the jetty-web.xml files in the section on deployment. It has nothing to do with deployment, it concerns only webapp startup.
There was a problem hiding this comment.
You need to know the existence of this feature if you want to properly prepare your application for deployment.
Is there a "webapp startup" documentation? If not, here would be the best place for now.
Signed-off-by: Simone Bordet <[email protected]>
No description provided.