Admin Console User Guide
for Use with JBoss Enterprise Application Platform 5
Edition 5.2.0
JBoss Operations Network Development Team
Edited by
Elspeth Thorne
Edited by
Eva Kopalova
Edited by
Isaac Rooskov
Edited by
Laura Bailey
Edited by
Petr Penicka
Edited by
Russell Dickenson
Edited by
Scott Mumford
Abstract
Chapter 1. Introduction to the Admin Console
- Services Binding Manager configuration, management and control
- Enterprise Application Platform instance information
- Application configuration, management and control for:
- Java EE Enterprise Applications (EARs)
- Web Applications (WARs)
- Resource Adapters (RARs)
- Enterprise JavaBean 2 and 3 (EJBs)
- Resource configuration, management and control for:
- data sources
- connection factories
- JMS queues and topics (based on JBoss Messaging)
production
, all
, web
and default
profiles. It has also been tested with the standard
server profile. Copy admin-console.war
from JBOSS_HOME/server/production/deploy
to the JBOSS_HOME/server/standard/deploy
directory to use the Admin Console with the standard
profile.
Note
minimal
configuration provided with the distribution. Custom configurations based on this configuration should not be used with the Admin Console, either.
Chapter 2. Configure the Admin Console
2.1. Security
jmx-console
. When the Enterprise Application Platform is installed using the zip archive, this security domain has no user accounts. This is to eliminate the possibility of default username/password based attacks. When the Enterprise Application Platform is installed using the Graphical Installer, a JAAS security domain and a user account is created as part of the install process. Even if the name of the JAAS security domain was changed during installation, the users are stored in the same location.
2.1.1. Authentication
jmx-console
and jboss-web
domains.
2.1.2. Enable Authentication
Procedure 2.1. Enabling Authentication
Enabling Authentication on the JMX console
In thisweb.xml
file:ensure the followingJBOSS_HOME/server/PROFILE/deploy/jmx-console.war/WEB-INF/web.xml
security-constraint
fragment is uncommented.<security-constraint> <web-resource-collection> <web-resource-name>HtmlAdaptor</web-resource-name> <description> An example security config that only allows users with the role JBossAdmin to access the HTML JMX console web application </description> <url-pattern>/*</url-pattern> </web-resource-collection> <auth-constraint> <role-name>JBossAdmin</role-name> </auth-constraint> </security-constraint>
Enabling Security Domain on the JMX console
In thisjboss-web.xml
file:ensure the following fragment is included.JBOSS_HOME/server/PROFILE/deploy/jmx-console.war/WEB-INF/jboss-web.xml
<jboss-web> <!-- Uncomment the security-domain to enable security. You will need to edit the htmladaptor login configuration to setup the login modules used to authentication users. --> <security-domain>java:/jaas/jmx-console</security-domain> </jboss-web>
Enabling Authentication on the Admin Console
In thisweb.xml
file:ensure the followingJBOSS_HOME/server/PROFILE/deploy/management/console-mgr.sar/web-console.war/WEB-INF/web.xml
security-constraint
fragment is uncommented.<security-constraint> <web-resource-collection> <web-resource-name>HtmlAdaptor</web-resource-name> <description> An example security config that only allows users with the role JBossAdmin to access the HTML JMX console web application </description> <url-pattern>/*</url-pattern> </web-resource-collection> <auth-constraint> <role-name>JBossAdmin</role-name> </auth-constraint> </security-constraint>
Enabling Security Domain on the Admin Console
In thisjboss-web.xml
file:ensure the following fragment is included.JBOSS_HOME/server/PROFILE/deploy/management/console-mgr.sar/web.console.war/WEB-INF/jboss-web.xml
<jboss-web> <!-- Uncomment the security-domain to enable security. You will need to edit the htmladaptor login configuration to setup the login modules used to authentication users. --> <security-domain>java:/jaas/jmx-console</security-domain> </jboss-web>
2.1.3. Users and Roles
JBossAdmin
and HttpInvoker
roles, as detailed in the procedure.
Procedure 2.2. Creating a User
Create a user in the jmx-console JAAS security domain
Edit the filejmx-console-users.properties
in the directoryJBOSS_HOME/server/PROFILE/conf/props/
.Create a username and password
Create a username = password pair.Important
The commentedadmin=admin
username and password is an example of the username/password definition syntax. Do not use this for your user account.
Create a user in the web-console JAAS security domain
- Edit the file
web-console-users.properties
in the directoryJBOSS_HOME/server/PROFILE/deploy/management/console-mgr.sar/web-console.war/WEB-INF/classes/
. Add username and password
Add the username = password pair.Important
The commentedadmin=admin
username and password is an example of the username/password definition syntax. Do not use this for your user account.
Grant web console permissions to user
- Edit the file
web-console-roles.properties
in the directoryJBOSS_HOME/server/PROFILE/deploy/management/console-mgr.sar/web-console.war/WEB-INF/classes/
. - Create an entry for the user of the form:
username=JBossAdmin,HttpInvoker
- JBossAdmin
- Grant the user permission to access the Web-Console
- HttpInvoker
- Grant the user permission to access the HTTP Invoker
Grant JMX console permissions to user
- Edit the file
jmx-console-roles.properties
in the directoryJBOSS_HOME/server/PROFILE/conf/props/
. - Create an entry for the user of the form:
username=JBossAdmin,HttpInvoker
- JBossAdmin
- Grant the user permission to access the Web-Console
- HttpInvoker
- Grant the user permission to access the HTTP Invoker
2.1.4. Disable Authentication
Warning
Procedure 2.3. Disabling Authentication
Disable security constraints on the JMX Console
In thisweb.xml
file:comment out theJBOSS_HOME/server/PROFILE/deploy/jmx-console.war/WEB-INF/web.xml
security-constraint
fragment.<security-constraint> <web-resource-collection> <web-resource-name>HtmlAdaptor</web-resource-name> <description> An example security config that only allows users with the role JBossAdmin to access the HTML JMX console web application </description> <url-pattern>/*</url-pattern> </web-resource-collection> <auth-constraint> <role-name>JBossAdmin</role-name> </auth-constraint> </security-constraint>
Disabling Security Domain on the JMX Console
In thisjboss-web.xml
file:remove the following fragment.JBOSS_HOME/server/PROFILE/deploy/jmx-console.war/WEB-INF/jboss-web.xml
<jboss-web> <!-- Uncomment the security-domain to enable security. You will need to edit the htmladaptor login configuration to setup the login modules used to authentication users. --> <security-domain>java:/jaas/jmx-console</security-domain> </jboss-web>
Disable security constraints on the Web Console
In thisweb.xml
file:comment out theJBOSS_HOME/server/PROFILE/deploy/management/console-mgr.sar/web-console.war/WEB-INF/web.xml
security-constraint
fragment.<security-constraint> <web-resource-collection> <web-resource-name>HtmlAdaptor</web-resource-name> <description> An example security config that only allows users with the role JBossAdmin to access the HTML JMX console web application </description> <url-pattern>/*</url-pattern> </web-resource-collection> <auth-constraint> <role-name>JBossAdmin</role-name> </auth-constraint> </security-constraint>
Disabling Security Domain for the Web Console
In thisjboss-web.xml
file:remove the following fragment.JBOSS_HOME/server/PROFILE/deploy/management/console-mgr.sar/web.console.war/WEB-INF/jboss-web.xml
<jboss-web> <!-- Uncomment the security-domain to enable security. You will need to edit the htmladaptor login configuration to setup the login modules used to authentication users. --> <security-domain>java:/jaas/jmx-console</security-domain> </jboss-web>
2.2. Access the Admin Console
Note
Note
Procedure 2.4. Access the Admin Console
- Using a web browser, navigate to http://localhost:8080. The JBoss Welcome Page is displayed.
- Select the 'Admin Console' link. The Admin Console login page is displayed.
- Enter credentials created in Section 2.1.3, “Users and Roles”, and click Login. The Admin Console is displayed.
2.3. Port Configuration
- ports-default: The standard ports, for instance JBoss Web listens for HTTP requests on 8080.
- ports-01: The standard ports incremented by 100. For example, HTTP is on 8180
- ports-02: The standard ports incremented by 200. For example, HTTP is on 8280
- ports-03: The standard ports incremented by 300. For example, HTTP is on 8380
2.3.1. Configure the Service Binding Manager
Procedure 2.5. Configuring the Service Binding Manager
- Navigate to the Service Binding Manager.
- Click the 'Configuration' tab.
- Edit 'Active Binding Set Name' to reflect the Service Binding Set to use.
- Click Save. For these changes to take effect, the Enterprise Application Platform must be restarted.
2.3.2. Add a Service Binding Set
Procedure 2.6. Adding a Service Binding Set
- Navigate to 'Service Binding Sets', located under the 'Service Binding Manager' menu.
- Click Add a new resource.
- Select the Resource Template to use (Service Binding Set). Click Continue.
- Enter Name, Default Host Name and Port Offset.
- Enter in any Override Bindings, by clicking Add New, and entering the required data. Click OK when finished.
- Click Save.
2.3.3. Service Binding Set Configuration
Procedure 2.7. Configuring a Service Binding Set
- Navigate to 'Service Binding Sets' and click on the Service Binding Set to be configured.
- Click on the 'Configuration' tab.
- Edit the fields to be changed.
- Click Save.
2.3.4. Display Bindings for a Service Binding Set
Procedure 2.8. Displaying Bindings for a Service Binding Set
- Navigate to 'Service Binding Sets' and click on the Service Binding Set for which the bindings are to be displayed.
- Click the 'Control' tab.
- Click Display Bindings. The bindings are displayed.
2.3.5. Delete Service Binding Sets
Procedure 2.9. Deleting a Service Binding Set
- Navigate to 'Service Binding Sets'.
- Click Delete to delete the Service Binding Set.
- Click OK to confirm the Service Binding Set is to be deleted.
Chapter 3. Applications
- Enterprise ARchives (EARs)
- Web Application aRchives (WARs)
- Resource Adapter aRchives (RARs)
- Enterprise Java Bean archives (EJBs), both EJB2 and EJB3
Application_Type
section of the Admin Console. Control of these embedded applications is through the parent EAR.
3.1. Deploy an Application
Procedure 3.1. Deploying an Application
Navigate to the Application type
- Expand the Applications menu by clicking on it.
- Click on the submenu of the type of application to add.
Configuring the Application
- Click Add a new resource.
- Specify the file to be deployed.
- Set options to deploy the application exploded, and to deploy the application as farmed.
Deploy the Application
Click Continue to deploy the application.
3.2. Update an Application
Procedure 3.2. Updating an Application
Navigating to the Content tab
- Click on the application's type submenu to expand it.
- Click on the application.
- Click on the Content Tab.
Finding the updated application file.
- Click Browse.
- Browse to the location of the updated application file.
- Click Open.
Performing the update.
Click Update. The currently deployed application will be replaced by the new application file.Important
The file to be updated must have the same name as the original application, otherwise the operation will fail.
3.3. Undeploy an Application
Procedure 3.3. Undeploying an Application
Navigate to the Application
Click on the application's type submenu to expand it.Undeploy the Application
- Click Delete next to the application.
- Confirm the removal of the application. The application is undeployed.
3.4. Controlling Applications
- Start
- Stop
- Restart
Procedure 3.4. Using Application Controls
Navigate to the Control Tab
- Click on the application's type submenu to expand it.
- Click on the application.
- Click the Control Tab.
Perform the operation
Click the operation to perform. The results of the operation are displayed.
Chapter 4. Resources
Important
4.1. JBoss Messaging
4.1.1. View the Deployed Messaging Queues
Procedure 4.1.
- Log in to the Admin Console of the Server at 127.0.0.1:8080/admin-console
For JBoss Messaging:
Click on Resources → JBoss Messaging → QueuesFor HornetQ:
Click on JMS Manager → JMS Queues
4.1.2. Add a JBoss Messaging Resource
Procedure 4.2. Adding a JBoss Messaging Queue
- Click Resources → JBoss Messaging → Queues. Click Add a new resource.
- Select the Template to use for the resource.
- Enter in the name of the Queue, and the JNDI name.
- Optional: Edit the other values available. For more information about Queue settings, refer to the JBoss Messaging User Guide.
- Click Save.
Procedure 4.3. Adding a JBoss Messaging Topic
- Click Resources → JBoss Messaging → Topics. Click Add a new resource.
- Select the Template to use for the resource.
- Enter in the name of the Topic, and the JNDI name.
- Optional: Edit the other values available, or leave them set to their default values. For more information about Topic settings, see the JBoss Messaging User Guide.
- Click Save.
4.1.3. Remove a JBoss Messaging Resource
Procedure 4.4. Removing a JBoss Messaging Resource
- Navigate to the JBoss Messaging Type - Topic or Queue, under Resources → JBoss Messaging.
- Click Delete next to the resource to be deleted.
- Click OK to confirm the delete operation.
4.1.4. JBoss Messaging Resource Configuration
Procedure 4.5. Configuring a JBoss Messaging Resource
- Navigate to the resource to be configured, using Resources → JBoss Messaging → MESSAGING_TYPE → RESOURCE_NAME.
- Click the 'Configuration' tab.
- When configuration options have been changed, click Save. For more information about configuration options, refer to the JBoss Messaging User Guide.
4.1.5. JBoss Messaging Resource Control
- Remove all messages - removes all messages from the destination.
- Start - starts the destination.
- Stop - stops the destination.
- List All Messages - lists all messages for the specified selector.
- List Durable Messages - lists all durable messages for the specified selector.
- List Non Durable Messages - lists all non durable messages for the specified selector.
- List Message Counter As HTML - displays the message counter as HTML.
- List Message Counter History As HTML - displays the message counter history as HTML.
- Reset Message Counter - resets the message counter to zero.
- Reset Message Counter History - clears the message counter history.
- List All Subscriptions - displays all subscriptions to the topic.
- List All Subscriptions As HTML - displays all subscriptions to the topic in HTML.
- List Durable Subscriptions - displays all durable subscriptions.
- List Durable Subscriptions As HTML - displays all durable subscriptions in HTML.
- List Non-Durable Subscriptions - displays all non-durable subscriptions.
- List Non-Durable Subscriptions As HTML - displays all non-durable subscriptions in HTML.
Procedure 4.6. Controlling a JBoss Messaging Resource
- Navigate to the resource, using Resources → JBoss Messaging → MESSAGING_TYPE → RESOURCE_NAME.
- Click the 'Control' tab.
- Click the operation to be performed. For information about the effect of these operations, refer to the JBoss Messaging User Guide.
4.2. Connection Factory
- No Tx Connection Factories - these do not take part in JTA transactions
- Local Transaction Connection Factories - these participate in local JTA transactions
- XA Transaction Connection Factories - these participate in distributed JTA transactions
4.2.1. Add a Connection Factory Resource
Procedure 4.7. Adding a Connection Factory to JBoss Messaging
- Navigate to the Connection Factory type required, under Resources → Connection Factories.
- Click Add a new resource.
- Select the template to use, and click Continue.
- Enter the JNDI name, RAR name, and Connection Definition in the labeled fields.
Note
The RAR for the associated Resource Adapter must be deployed before adding the Connection Factory. - Configure extra options for the connection factory. For more information about configuration options, see the JBoss Messaging User Guide.
- Click Save. The new Connection Factory will be displayed in the Admin Console.
4.2.2. Remove a Connection Factory Resource
Procedure 4.8. Removing a Connection Factory
- Navigate to the Connection Factory type of the Connection Factory to be removed, under Resources → Connection Factories.
- Click Delete next to the Connection Factory to be removed.
- Click OK to confirm the removal of the Connection Factory. The Connection Factory is removed.
4.2.3. Connection Factory Resource Configuration
Procedure 4.9. Configuring a Connection Factory
- Navigate to the Connection Factory type, under Resources → Connection Factories.
- Click the Connection Factory.
- Click the 'Configuration' tab.
- When the attributes have been edited, click Save. The configuration of the Connection Factory is changed.
4.2.4. Control a Connection Factory Resource
- Flush - Flush the connections in the pool
- List Formatted Sub Pool Statistics - gives a report on sub pool statistics
- List Statistics - general statistics report for the Connection Factory
- Test Connection - test the Connection Factory to ensure that connections can be obtained
Procedure 4.10. Controlling a Connection Factory
- Navigate to the Connection Factory type, under Resources → Connection Factories.
- Click the Connection Factory.
- Click the 'Control' tab.
- Click the required operation. Result of the operation is displayed.
4.3. Datasources
No Tx
datasource. This does not take part in JTA transactions. Usesjava.sql.Driver
.Local Tx
datasource. This does not support two phase commit. Usesjava.sql.Driver
. Suitable for a single database or a non-XA-aware resource.XA
datasource. This supports two phase commit. Usesjavx.sql.XADataSource
.
4.3.1. Add a Datasource
Procedure 4.11. Adding a Local Tx or No Tx Datasource
- Navigate to the Datasource type to be added, under Resources → Datasources.
- Click Add a new resource.
- Select the resource template from the drop-down box, and click Continue.
- Enter required parameters of JNDI Name, JDBC Driver Class and Connection URL.
- Optional: Configure extra options for the datasource. For more information about datasource configuration, see the Administration and Configuration Guide.
- Click Save. The datasource is available.
Procedure 4.12. Adding an XA Datasource
- Navigate to the XA Datasource type, Resources → Datasources → XA Datasources.
- Click Add a new resource.
- Select the resource template from the drop-down box, and click Continue.
- Enter required parameters of JNDI Name and XA DataSource Class.
- Optional: Configure extra options for the datasource. For more information about datasource configuration, see the Administration and Configuration Guide.
- Click Save. The XA datasource is available.
4.3.2. Remove a Datasource
Procedure 4.13. Removing a Datasource
- Navigate to the Datasource type, under Resources → Datasources.
- Click Delete next to the datasource to be removed.
- Click OK to confirm the removal of the datasource. The datasource is removed.
4.3.3. Datasource Configuration
Procedure 4.14. Configuring a Datasource
- Navigate to the Datasource type, under Resources → Datasources.
- Click the Datasource.
- Click the 'Configuration' tab.
- When the attributes have been edited, click Save. The configuration of the Datasource is changed.
4.3.4. Datasource Control
- Flush. This flushes connections in the datasource pool.
- List Formatted Sub Pool Statistics. Displays a formatted sub pool statistics report.
- List Statistics. Displays a statistics report.
- Test Connection. Check that a connection is obtainable.
Procedure 4.15. Controlling a Datasource
- Navigate to the datasource, at Resources → Datasources → DATASOURCE_TYPE → DATASOURCE_NAME.
- Click the 'Control' tab.
- Click the operation to be performed.
4.4. Scripts
classpath.sh
- used to set the class path for server and client.jboss_init_hpux.sh
- sample initialization script for HP-UX systems.jboss_init_solaris.sh
- sample initialization script for Solaris systems.password_tool.sh
probe.sh
- used to discover EAP clusters.run.sh
- starts an instance of the Enterprise Application Platform. For usage, see the Getting Started Guide.shutdown.sh
- shuts down the Enterprise Application Platform instance.twiddle.sh
wsconsume.sh
- generates portable JAX-WS artifacts from a WSDL file.wsprovide.sh
- generates portable JAX-WS artifacts for an endpoint implementation.wsrunclient.sh
- builds correct classpath and libraries for JAX-WS web service client.wstools.sh
Procedure 4.16. Running a Script
Navigating to the script
- Navigate to the Scripts section in the Admin Console, Resources → Scripts.
- Click the script to be run.
- Click the 'Control' tab.
Running the script
- Click Execute Script.
- Enter in the appropriate parameters, if any, and click OK.
- When the script has finished running, the results are displayed.
Chapter 5. Monitor the JBoss Enterprise Application Platform Instance
- The EAP instance
- Queues
- Topics
- Connection Factories
- Datasources
Procedure 5.1. Accessing Metrics
- Navigate to the resource you wish to display metrics for.
- Click the 'Metrics' tab. Metrics are displayed.
- Optional: Click Refresh to get the latest data.
Appendix A. Revision History
Revision History | |||||||
---|---|---|---|---|---|---|---|
Revision 5.2.0-100.400 | 2013-10-30 | Rüdiger Landmann | |||||
| |||||||
Revision 5.2.0-100 | Wed 23 Jan 2013 | Russell Dickenson | |||||
| |||||||
Revision 5.1.2-102 | 17 Sep 2012 | Russell Dickenson | |||||
| |||||||
Revision 5.1.2-101 | Mon 30 January 2012 | Russell Dickenson | |||||
| |||||||
Revision 5.1.2-100 | Thu Dec 8 2011 | Jared Morgan | |||||
| |||||||
Revision 5.1.1-100 | Mon Jul 18 2011 | Jared Morgan | |||||
| |||||||
Revision 5.1.0-100 | Tue Aug 03 2010 | Rebecca Newton | |||||
|