[WFLY-11676] Documentation for feature that provides ability to list module dependencies of a deployed application #12041
Conversation
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
yersan
commented
Feb 6, 2019
docs/src/main/asciidoc/_developer-guide/Class_Loading_in_WildFly.adoc
Outdated
Show resolved
Hide resolved
yersan
force-pushed
the
docs/WFLY-11676
branch
from
48ee499
to
6d0ef6c
Compare
kabir
added
core-upgrade-needed
bstansberry
requested changes
Feb 7, 2019
| [[how-to-list-the-module-dependencies-of-a-deployed-application]] | ||
| == How to list the module dependencies of a deployed application | ||
|
|
||
| In Wildfly it is possible to list the module dependencies added by the container to your deployed application. This task can be achieved via the command line interface, where specific commands are available to list the module dependencies for deployments and ear-subdeployments. |
There was a problem hiding this comment.
s/commands/operations
In CLI terms a 'command' is a high level command, while an 'operation' is for the stuff that gets parsed into DMR.
| [standalone@localhost:9990 /] /deployment=test-application.war:list-modules | ||
| ---- | ||
|
|
||
| In case of ear-subdeployments, the _list-modules_ command is also available under subdeployment resource: |
| [standalone@localhost:9990 /] /deployment=test-application.ear/subdeployment=test-application.war:list-modules | ||
| ---- | ||
|
|
||
| If you are running Wildfly in a domain mode, this operation is available via the server resource at host level: |
There was a problem hiding this comment.
s/a domain/domain/g
s/at host/at the host/g
| [domain@localhost:9990 /] /host=master/server=server-one/deployment=test-application.ear/subdeployment=test-application.war:list-modules | ||
| ---- | ||
|
|
||
| By default, _list-modules_ operation shows the list of dependencies in a compact view, including only the module name. You can control this output using the attribute _verbose=[false*|true]_ to enabling/disabling a detailed response. |
There was a problem hiding this comment.
s/default,/default, the/g
s/enabling/enable/g
s/disabling/disable/g
| ---- | ||
|
|
||
|
|
||
| The _list_modules_ command shows information in three different categories: |
|
|
||
| * system-dependencies: These are the dependencies added implicitly by the server container. | ||
| * local-dependencies: These are dependencies on other parts of the deployment. | ||
| * user-dependencies: These are the dependencies defined by the user via manifest file or deployment-structure.xml. |
|
|
||
| For each module, the following information is shown: | ||
|
|
||
| * name: The module name and, if the slot name is not the default "main" slot, the slot name is concatenated after ":" character separator. |
| * name: The module name and, if the slot name is not the default "main" slot, the slot name is concatenated after ":" character separator. | ||
| * optional: If the dependency was added as an optional dependency. | ||
| * export: If the dependency is being exported to other modules. | ||
| * import-services: If this module is importing services from other dependencies. |
There was a problem hiding this comment.
Is this more like
"If the module for the deployment or subdeployment is allowed to import services from the dependency."
?
That's the meaning of a 'services="import"' attribute on a dependency element in module.xml and looking at the setting of org.jboss.as.server.deployment.module.ModuleDependency.isImportServices() it is 'true' in the 'services="import"' situation, 'false' otherwise.
There was a problem hiding this comment.
Yes, "allowed to import" is a much better description.
yersan
force-pushed
the
docs/WFLY-11676
branch
from
6d0ef6c
to
4df0105
Compare
…module dependencies of a deployed application [WFLY-11676] Correction in the documentation
yersan
force-pushed
the
docs/WFLY-11676
branch
from
4df0105
to
7b2a0d4
Compare
|
@bstansberry I've just addressed all the points, thank you for the review. |
bstansberry
approved these changes
Feb 8, 2019
bstansberry
removed
the
core-upgrade-needed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Community documentation for WFCORE-4251, which provides the ability to list modules which are on deployment's classpath.
Jira issue: https://issues.jboss.org/browse/WFLY-11676
Analysis doc: wildfly/wildfly-proposals#159