THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
This topic describes the overall portlets layout and features that you can utilize within the Administration Console. If you prefer a command line interface, see Tools and commands for command line usage.
Overview
The Geronimo Administration Console is a Web based interface that provides a convenient, user-friendly way to administer many aspects of the Geronimo server. After you have the Apache Geronimo server started (see Starting and stopping the server), you can access the Administration Console by navigating your browser to the following URL:
The Administration Console login page is depicted in the following figure.
Log in by specifying system as the username and manager as the password. After you are logged in, you will be redirected to the console's welcome page. The console has two main areas, a navigation panel on the left and a main content area on the right.
The navigation panel on the left provides easy access to the individual tasks. It is always present and allows easy transition from task to task. The main content area on the right is where the real work happens. This area will change as you select the different tasks in the navigation panel on the left. Each view contains one or more portlets that typically include a link for help in the header. See the following figure as an example.
Console Navigation (left panel)
As briefly explained in the previous section, the navigation panel provides access to the different tasks for administering resources in Geronimo. It also provides two modes for listing these tasks, Basic and Advance. Select the Basic or Advance radio button on the top of the console navigation panel to switch a configuration between the two modes.
- The basic mode is the default configuration mode for the navigation panel, displaying the most frequently used functions, including:
${renderedContent}
${renderedContent}
${renderedContent}
${renderedContent}
- The advance mode diaplays links to every portlet included in the console. It is organized in the following main groups:
${renderedContent}
${renderedContent}
${renderedContent}
${renderedContent}
${renderedContent}
${renderedContent}
${renderedContent}
not on the console yet:
#Embedded DB
#Debug Views
Search bar
The Search bar provides convenient searching capabilities for finding portlets on the navigation panel. Type in the search field and press enter to launch the portlet that you need.
Welcome
This is the welcome page that you see when you log in. It provides a general description of what the Geronimo Administration Console is and some shortcut links to common tasks such as:
Common Console Actions
This page also provide links to:
Geronimo Online
- The Geronimo Home Page
- Bug report
- Users Mailing List Archive
- Developers Mailing List Archive
- Geronimo IRC chat
Geronimo Documentation
Application Server
Organized under the Application Server group, you will find statistical information and support for configuring and administering the server. This group is organized as follows:
${renderedContent}
${renderedContent}
${renderedContent}
# JMS Server
# EJB Server
# Derby server
# New server assembly
not on the console yet:
#JMS Server
#EJB Server
System Information
Organized under this group you will find links for the following portlets:
Server Information
This portlet displays server information such as the version, start time and up time. In addition, it also provides information about the JVM such as Java Version, Vendor, Node, and Server Memory Usage.
Java System Info
This portlet displays the values of the system properties available to the server process.
Thread Pools
This portlet lists all the thread pools defined in the server. You can see the pool size and monitor individually each of the listed thread pools with this portlet. By monitoring these threads, you can gather statistical information such as pool max, lowest recorded, highest recorded, and threads in use.
Web Server
This option provides two portlets, Web Server Manager and Network Listeners.
- Web Server Manager ? not sure
When this portlet is enabled, it will collect server performance statistics. The values being measured are:- Total Requests
- Total 1xx, 2xx, 3xx, 4xx, 5xx Responses
- Active Request Count (Current, Low, High)
- Request Duration
- Network Listeners
This portlet displays all the connector listeners (HTTP, HTTPS and AJP) and status for both Jetty and Tomcat Web containers. From this portlet, you can add new listeners and change the status (stop, restart, edit, delete) of the existing connectors.
Shutdown
Clicking Shutdown will shutdown the server and cause the JVM to exit. To continue using the Geronimo Console after a shutdown, you must restart Geronimo.
JMS Server
This option provides two portlets, JMS Server Manager and JMS Network Listeners.
- JMS Server Manager
This portlet displays the available JMS Brokers and their state.
- JMS Network Listeners
This portlet displays all the network connectors configured for the currently available JMS Brokers. From this portlet, you can also start, stop, edit, add, and delete JMS network connectors. Some connectors available to be added to ActiveMQ are tcp, stomp, vm, udp and multicast listeners.
EJB Server
This portlet provides all EJB statistics deployed in the server including stateless(stateful) Containers, CMP(BMP) Entity Containers and Message Driven Containers. By default, Geronimo is using Openejb as its EJB 3.0 implementation.
Applications
Organized under this group you will find links for installing and administering applications.
${renderedContent}
${renderedContent}
${renderedContent}
${renderedContent}
${renderedContent}
not on the console yet:
#Plan Creator
Deployer (? from Deploy new. see if plan creator is merged here)
This portlet allows you to deploy new applications to the Apache Geronimo server. For example, a Web applications requires a deployment plan, which is either packaged within the war file with the name geronimo-web.xml, or kept as a separate XML file that is deployed by using the Plan field in the Deployer portlet. See Deploying applications Via Geronimo Administration Console for more information on using the Deployer function.
User Assets
Organized under this group you will find links for the following portlets:
Web App WARs
This portlet displays the installed Web applications and their status. From this portlet, you can stop, start, and uninstall the available Web applications. This portlet provides the following two options that help manage Web applications:
- Expert mode, which enables all actions for components. This mode can be understood as an override feature that grants you the authority to perform options (Stop, Restart, and Uninstall) on components which are otherwise grayed out and can cause the application server to malfunction. You can use this mode by clicking the following Expert mode check box.
- Show parent and child components option, which displays the parent and child components of the Installed Web Applications. The parent components refer to the components that the Installed Web Applications dependent on, while the child components are the components that dependent on the Installed Web Applications. You can use this option by clicking the following check box.
Application EARs
This portlet displays the installed Application EARs and their status. From this portlet, you can stop, start, and uninstall the available application EARs.
In addition, this portlet makes use of the Expert Mode and Show parent and child components features as described here.
EJB JARs
This portlet displays the installed EJB JARs and their status. From this portlet, you can stop, start, and uninstall the available EJB JARs.
In addition, this portlet makes use of the Expert Mode and Show parent and child components features as described here.
App Clients
This portlet displays the installed Application Clients and their status. From this portlet, you can stop, start, and uninstall the available application clients.
In addition, this portlet makes use of the Expert Mode and Show parent and child components features as described here.
Application EBAs
This portlet displays the installed Application EBAs and their status. From this portlet, you can stop, start, and uninstall the available application EBAs.
In addition, this portlet makes use of the Expert Mode and Show parent and child components features as described here.
Plan Creator
This portlet features assisting you in creating a Geronimo Deployment Plan. Currently only supporting WAR files. For details visit the Creating deployment plans using the deployment plan wizard section. Starting from v2.2, this portlet is optional, you can enable it by installing a plugin from Geronimo repository.
Resources
Organized under this group you will find links for configuring the following services:
# DB pools
# JMS Resources
J2EE Connectors
#JAR Aliases
#Repository
#Apache HTTP
#System Modules
#Plugins
#Bundles
not on the console yet:
#Database Pools
#JMS Resources
J2EE Connectors
This portlet displays the installed J2EE connectors and their status. From this portlet, you can stop, start and, uninstall the available J2EE Connectors.
In addition, this portlet makes use of the Expert Mode and Show parent and child components features as described here.
JAR Aliases
This portlet allows you to manage the existing artifact aliases on the Geronimo server, which means you can update the artifact_aliases.properties file directly on the administration console.
Repository
This portlet provides two functionalities. Firstly, it assists in adding an archive into the Repository. Secondly, it displays the artifacts installed in the server's repository. The layout of the repository is the same as that used by Apache Maven, which makes it possible to easily copy files over. From this portlet, you can install new artifacts. To use these artifacts in an application, you need to modify your deployment plan according to Define the dependency in the deployment plan. For more information on using the repository portlet, see Update the repository with new library.
Apache HTTP
This portlet is a wizard that walks you through the process of configuring Apache Geronimo to use a remote Apache 2 HTTP server. To configure the remote HTTP server, you need to install the mod_jk Apache module on the remote server. Based on a series of questions, the wizard will guide you through the configuration process. See Configuring a remote Apache HTTP server for two alternative ways to configure a remote Apache HTTP server.
System Modules
This portlet displays the installed System Modules and their status. From this portlet, you can stop, start, and uninstall the available System Modules.
In addition, this portlet makes use of the Expert Mode and Show parent and child components features as described here.
Plugins
This portlet allows you to install or create Geronimo plugins. From this portlet, you can install the plugins available in the remote plugins repository you selected, or export to plugins just about any module you have already installed in Geronimo. In addition, you can create custom assembly server packages built with only the modules you specify. For more information on using the plugins portlet, see Converting applications into plugins using the Administration Console.
OSGI Bundles
This portlet allows you to install OSGi Bundles to the Apache Geronimo server. You can define a start level for the bundle you install by inputting a non-negative integer into the Start Level field.
This portlet displays the installed OSGi Bundles and their status in the table under the installation area. Double click one bundle in the table, you will see the content of the MANIFEST.MF file of the bundle. From this portlet you can stop, start, and uninstall the available bundles in this table. For more information, see Managing OSGi Bundles.
Database Pools
This portlet displays all the available database pools and their status. Only server-wide database pools can be edited in this portlet. For database pools deployed as part of a single application, you will have to change the deployment plan in the application to edit these database pools.
From this portlet you can edit the available, system-wide, database pools. A usage link with examples of how to use the pool from your application is also provided.
This portlet includes a database pool creation wizard for new pools and also lets you import database pools from JBoss 4 and WebLogic 8.1.
JMS Resources
This portlet lists all the JMS resource groups and states available in the Geronimo server, that is queues and factories. From this portlet, you can create new JMS resource groups. This portlet provides two wizards, one for ActiveMQ and one for another JMS provider. For the latter, you will have to provide the specific resource adapter RAR needed to connect to that particular provider.
Security
#Users and Groups
#Keystores
#Certificate Authority
#Security Realm
Users and Groups
This option provides two portlets, Console Realm Users and Console Realm Groups.
- Console Realm Users
This portlet displays all the Console Realm Users and allows you to add, change password, and delete them.
- Console Realm Groups
This portlet displays all the Console Realm Groups and allows you to add, modify, and delete them.
Keystores
This portlet walks you through the process of configuring keystores to use with SSL connectors. From this portlet, you can add or edit keystores, add Trust Certificates, and create private keys. See the Administering certificates section about how to create a keystore and a private key with the keystores portlet. See the Certificate Properties File Realm about how to create and import certificates.
Certificate Authority
This portlet allows you to create a Certification Authority (CA) in Geronimo and issue certificates in reply to Certificate Signing Requests (CSRs). Click here for more detailed instructions.
Security Realm
This portlet displays all available security realms and their status. Only server-wide security realms can be edited in this portlet. Security realms deployed as part of a single application cannot, and you will have to change the deployment plan in the application instead.
From this portlet you can edit the available, system-wide, security realms. There is also a usage link with examples of how to use the realm from your application.
This portlet also includes a security realm creation wizard for creating new realms. For more information on using the security realm portlet, see Administering security realms.
Monitoring and Troubleshooting
Organized under this group you will find links for:
# Monitoring
# Debug Views
o JMX Viewer
o Classloader Viewer
o JNDI Viewer
o Dependency Viewer
not on the console yet:
#Monitoring
Logs
Organized under this group, you will find links for the following item.
Server Logs
This option provides four portlets, Log Manager, Server Log Viewer, Web Access Log Viewer and Derby Log Viewer.
- Log Manager
This portlet allows the user to select a configuration file for logging and/or change the log level and Refresh interval. The default "Config file" is a standard log4j file and defines the location where the Geronimo Server will log Geronimo output. The configuration file also defines the log level that allows a finer control of what is being logged.
- Server Log Viewer
This portlet displays the Geronimo server log and is helpful for debugging problems with the Geronimo Console and with deployed applications.
- Web Access Log Viewer
This portlet displays and filters the Web container log file. This log file contains HTTP accesses and messages from JSP and servlet applications that are running on Geronimo. By default, this portlet displays the contents of the log file for the current date. You can apply different filtering criteria to view only data of your interest.
- Derby Log Viewer
This portlet displays the log file for Geronimo's internal database, Derby. (not sure of the information yet
For more information, see Configuring log level.
Back to Monitoring and Troubleshooting
Monitoring
The Geronimo monitoring plugin is broken down between server and client plugins, referred to as the 'Agent' and 'Console' respectively. When properly set up, these plugins provide both local and remote real-time JSR77 compliant statistic monitoring, and historical tracking of any exposed statistic with visual representations drawn in the form of graphs through the Dojo Toolkit's dojoX Charting packages. Starting from v2.2, this portlet is optional, you can enable it by installing a plugin from Geronimo repository.
Embedded DB
Organized under this group you will find links:
DB Info
This portlet displays information about the internal database, such as:
- Database Product name and version.
- Driver and version.
- Connection URL.
- Supported functions and the supported SQL commands.
DB Manager
This option provides two portlets, DB VIewer and Run SQL.
- DB Viewer
This portlet displays all the available databases and their tables, and displays the contents of the tables. To view the tables in a particular database, click on the database link. This will show all the tables in the database. To view the contents of the tables, click on the View Contents link. At the bottom of the DB Viewer portlet, there are links to take you back to View Databases or View Tables.
- Run SQL
This portlet lets you run SQL commands to manipulate the data in the tables, create a new database, or delete a database. You can enter the SQL commands in the SQL Command(s) text box, select the database that will be used, and then click on Run SQL to execute the command.
Debug Views
Organized under this group you will find links:
#JMX Viewer
#LDAP Viewer
#ClassLoader Viewer
#JNDI Viewer
#Dependency Viewer
Starting from v2.2, these portlets are optional, you can enable them by installing a plugin from Geronimo repository.
JMX Viewer
This portlet provides a tree like representation for you to browse the different types of MBeans. Each MBean will be represented as a tree node that shows its object name representation. All MBeans will give you a list of MBeans grouped by its domain.
LDAP Viewer
This portlet lets you connect to any LDAP server, and browse its content but not edit it. This portlet comes predefined to access the LDAP embedded in Geronimo, make sure the service is running before you connect to the server.
ClassLoader Viewer
This view can be used to all the classloader involved in the server and the classes it loads.
JNDI Viewer
This view can be used to view JNDI context for various modules.
Dependency Viewer
This view can be used to view all the modules and its dependencies.