Admin Console QuickStart

8/13/2019 Admin Console QuickStart

1/21

Quick Start GuideVersion 1.2.0.GA

This document is intended to provide a reference to quickly et you started !ith the ne!ly released"#ossAS Administration $onsole alon !ith a %asic overvie! of the features it provides to assist !iththe manaement of your "#oss Application Server & installation.

Overview

This first release of the "#ossAS Administration $onsole 'referred to as $onsole in later references

throuhout this Guide( provides the follo!in administrative features) $onfiuration *nformation a%out the System the "#oss Application Server is runnin on

+eploy, -ndeploy, and -pdate nterprise Applications includin)

nterprise Applications 'A/s(

e% Applications 'A/s(

/esource Adapters'/A/s(

"# "A/s '"#2 and "#(

ersistent confiuration chanes for the follo!in resources)

+ata Sources $onnection 3actories "4S Queues and Topics %ased on "#oss 4essain

$ontrol 5perations Stop, Start, /estart Applications Vie! /esource Statistics Vie! /esource 4etric *nformation

3or related community pro6ect information for the $onsole and "#oss Application Server &, see thereferences section at the end of this document.

7et8s et started . . .

1

8/13/2019 Admin Console QuickStart

2/21

Installation

+o!nload "#oss Application Server &.1.0.GA from the "#oss AS community do!nload pae)

http)99!!!.6%oss.or96%ossas9do!nloads9

$lick on the +o!nload link and select the platform:independent ;ip distri%ution for the "+< you8ll %eusin)

"avaS & =jboss-5.1.0.GA.zip

"avaS > =jboss-5.1.0.GA-jdk6.zip

/efer to the"#oss AS &.1.0.GAand "#ossAS Administration $onsole/elease ?otes for specificinformation on these pro6ect releases.5nce the do!nload has completed, un;ip it to an installation directory of your choice. e !ill refer to

"#5SS@54 as Binstallation:dirC96%oss:&.1.0.GA

The $onsole is distri%uted as part of the 'default'and'all'server confiurations.

Start the "#oss AS & server)

$JBOSS_HOME/bin

and eDecute the command./run.shfor -niD systems

or

run.bat for indo!s systems

The a%ove command starts the 'default'confiuration. *f you prefer to run !ith an alternateconfiuration, repeat the a%ove command passin in your confiuration usin the :c option. #elo! isthe syntaD for startin the server !ith the 'all'confiuration.

Dample)./run.sh -c all

orrun.bat -c all

*n addition to the 'default'and 'all'confiurations, the $onsole has %een tested !ith the 'standard'confiuration !hich is also a confiuration provided !ith this distri%ution. To use the $onsole !iththe 'standard'confi, you can copy the admin:console.!ar directory from the 'default'serverconfiuration as sho!n %elo!.

cd $JBOSS_HOME/server/default/deploy

cp -pr admin-console.war $JBOSS_HOME/server/standard/deploy

2

8/13/2019 Admin Console QuickStart

3/21

*t is eDpected that that $onsole !ill !ork !ith any custom confiuration. -se the a%ove commandreplacin 'standard'!ith the custom confiuration name of your choice. *f you happen to encounterissues, please file an 4#"5/"*/A to alert us of the pro%lem.

*NOTE: JBoss AS Administration Console is not supported with the 'minimal' or 'web'confiurations pro!ided with the distribution nor confiurations based on those"

Accessing the Console

5nce the server is started, the $onsole is ready to assist you !ith your Application Serveradministration tasks. Simply point your %ro!ser to)

http)99localhost)E0E09admin:console

*NOTE: The Console has been tested with #o$illa %ire%o& and (nternet E&plorer )"

This !ill %rin you to the "#oss AS Administration $onsole 7oin pae.

7oin credentials are the same as used for the "4F console. A default user is provided for out:of:%oDaccess. hen prompted, enter adminfor -sername and ass!ord .

$lick the Login %utton.

8/13/2019 Admin Console QuickStart

4/21

*NOTE: To chane the default loin or to add additional users !isit the +ed ,at -nowlede Base tofind out .,ow to enable authentication on JBoss ser!ices such as rmi/http 0m&/console and web/console12"

The $onsole provides a sinle administration point for manain and modifyin your Applications andSystem /esources. Add, -pdate, 4odify, and +elete functions are availa%le for all resource types.

$ontrol 5perations, /esource 4etrics, and $onfiuration modifications are availa%le dependin on thethe resource type.

Navigation Overview

5nce successfully loed in you have an overall Summary of the "#oss AS & server runnin. The leftnaviation pane allo!s direct access to any administrative task. ?ote that these tasks are availa%le forthe "#oss AS & server confiuration currently runnin as sho!n in the parenthesis. 5nly one runninserver is manaed at a time.

$lick on the "#oss AS & 'confi( link and an overvie! of the system that the "#oss server is runnin onsuch as 5peratin System information and host name is sho!n.

8/13/2019 Admin Console QuickStart

5/21

All applications and resources discovered durin server start up are availa%le. The screen shot %elo! issho!n !ith all the vie!s eDpanded. *f your vie! is not consistent !ith the teDt in this document %einreferenced, %e sure that the vie! is eDpanded %y clickin on the arro! neDt to the item %einreferenced.

&

8/13/2019 Admin Console QuickStart

6/21

Applications Overview

All applications discovered !hen the server !as started are listed in the Summary vie!. o!ever,Applications can %e listed %y their Types to simplify the vie!. The Applications Types that can %emanaed in this release are)

"# 2.D Application '"# "A/(s "# .D Application '"# "A/(s m%edded "# 2.D Application '"# "A/(s m%edded "# .D Application '"# "A/(s m%edded /esource Adapters '/A/(s

m%edded e% Applications 'A/(s nterprise Applications 'A/(s /esource Adapters '/A/(s e% Applications 'A/(s

?ote that the m%edded application types !ere deployed as part of an nterprise Archive. They arelisted separately for easier manaement and each em%edded archive sho!s the relationship to its8 parent

>

8/13/2019 Admin Console QuickStart

7/21

in the Summary ta%. m%edded applications are manaed via their parent. *n other !ords, theycannot %e deleted or updated nor do control operations apply. The manaement of these applicationsare done via the operations on the parent. Applications are eDpected to %e "ava:compliant andappropriately packaed for deployment to the application server includin any specific runtimedescriptor information.

Add New Application eso!rce

To add 'deploy( applications, naviate to the Application type you !ant to add. *n this eDample, !e!ill use an nterprise Applications.

$lickin on the link "nterprise Applications #"As$

ill %rin you to the nterprise Application 'A/( Summary Ta%.

H

8/13/2019 Admin Console QuickStart

8/21

$lickin on

%rins you toAdd New "nterprise Application #"A$ta%. $lick the %O&'"%utton and selectthe .ear file to %e deployed. $lick (ON)*N+"to proceed !ith the application deployment. Thestatus of the deployment !ill %e sho!n and if successful, added to the list of applications ready to %emanaed. 5ther!ise, the reason for the failed deployment !ill %e sho!n.

3ollo! this procedure for other Application Types that you !ant to Add.

(ontrol Operations

$ontrol 5perations are availa%le for all Application Types. 3rom the nterprise Application SummaryTa%, select the nterprise Application deployed in the a%ove step. This %rins you to the Summary Ta%of that deployed application. Select the $ontrol Ta%.

The 5perations availa%le for Application Types are)

')A) starts this A/

')O, stops this A/

"')A) stops and then restarts this A/

+pdating Applications

To -pdate the Application $ontent, select the Application that you !ant to -pdate. $lick on the$ontent Ta%. #/5S to the location of !here the updated Application resides.

E

8/13/2019 Admin Console QuickStart

9/21

*NOTE: The file to be 3pdated must be the same name as the application selected for 3pdate"

eleting Applications

Applications can %e +eleted %y naviatin to the Applications Summary Ta% or the Application:specific Type 'such as nterprise Application( Summary Ta% %y simply clickin the "L")"%uttonneDt to the name of the Application you !ant to delete. 5nce the +7T has %een confirmed, theApplication !ill %e undeployed from the server and !ill no loner %e a%le to %e manaed. Iou canal!ays Add the resource aain if needed. As noted a%ove, m%edded Applications !ill not have the+7T option availa%le.

J

8/13/2019 Admin Console QuickStart

10/21

eso!rces Overview

$lick on the /esources link from the left ?aviation pane)

%rins you to the /esources landin pae sho!in the different types of /esources to %e manaed.

Specifically,

"#oss e% Servlet $ontainer $onnectors Virtual osts

10

8/13/2019 Admin Console QuickStart

11/21

$onnection 3actories ?o TD $onnection 3actories TD $onnection 3actories

+atasources 7ocal TD +atasources ?o TD +atasources

FA +atasources "4S +estinations

Topics Queues

hether addin ne! resources or modifyin resources already deployed to the runnin server, the$onsole offers easy manaement of the resource properties avoidin error:prone editin of F47confiuration files. ?eDt to each edita%le property is a +escription detailin the use of the property,default value if any, and the affect of the property chane. $onfiuration errors are immediatelydetected and !ill %e hihlihted !hen the attemptin to 'A". At any time durin editin of aresource confiuration, the chanes can %e (AN("Led. +etailed overvie! of the different resourcetypes is provided %elo!.

/%oss &eb eso!rces

(onnectors

TT

The TT connector is setup %y default !ith "#oss e% and is ready to use. This connectorfeatures the lo!est latency and %est overall performance.

A"

*f interation !ith the native !e% server is needed, an A" connector !ill provide fasterperformance than proDied TT. The native connectors supported !ith "#oss e% in "#ossApplication Server &.1.0.GA release are)

11

8/13/2019 Admin Console QuickStart

12/21

"< 1.2.D !ith any of the supported servers

mod@proDy on Apache TT Server 2.D 'included %y default in Apache TT Server2.2(, !ith A" ena%led

irt!al osts

/efer to theVirtual ostsarticle sho!in an eDample confiuration !ith "#oss ApplicationServer &.

(onnection actories

Select $onnection 3actories link under /esources to confiure a "$A resource adapter connectionfactory.

*NOTE: The resource adapter must alread4 be deplo4ed prior to confiurin the connectionfactor4" (f this has not 4et been done simpl4 na!iate to the +esource Adapters5+A+6s or Enterprise Application 5EA+6s 5for a resource adapter deplo4ed as part of an EnterpriseArchi!e6 from Applications as described abo!e"

After clickin on the $onnection 3actories link, you !ill %e %rouht to the $onnection 3actoriesSummary Ta% !here the eDistin connection factories deployed to the runnin server !ill %e sho!n.The default vie! is All types !here the Type of $onnection 3actories are)

?o TD $onnection 3actories TD $onnection 3actories

Add New (onnection actor2

To add a ne! connnection factory , select the $onnection 3actory Type you !ant to add.Select ?o TD $onnection 3actory to confiure a connection factory that does not participate in "TAtransactions. Alternatively, select the TD $onnection 3actory link for connection factories that !illparticipate in "TA transactions. After makin your selection, click on the KAdd a new reso!rceL %utton

12

8/13/2019 Admin Console QuickStart

13/21

8/13/2019 Admin Console QuickStart

14/21

(onnection actor2 (ontrol Operations

3rom the $ontrol ta% of any selected $onnection 3actory, you can 3lush the connection pool or o%tainstatistics, includin Su% ool statistics.

1

8/13/2019 Admin Console QuickStart

15/21

ataso!rcesAdministration tasks for +atasources are the similar to !hat has %een descri%ed for $onnection3actories. The main difference is in the template selection for confiurin the resources. To add ormodify a previously deployed datasource, click on the +atasources link in the left naviation panel.The +atasources Summary Ta% is displayed sho!in the datasources confiured in the runnin serverconfiuration. The default vie! is to list all +atasource Types. The types of +atasources are)

7ocal TD +atasources ?o TD +atasources FA +atasources

Add New ataso!rce

To add a ne! +atasource, select the +atasource Type you !ant to add. The +atasource types are self:eDplanatory. Select the appropriate +atasource type that you !ant to add. After makin your selection,click on the KAdd a new reso!rceL %utton on the riht side of your %ro!ser. Iou !ill %e prompted forthe template that !ill %e used to create the confiuration. Iour template choices for datasource typesare)

7ocal TD +atasource 5racle 7ocal TF '7ocal TD +atasource( default '7ocal TD +atasource(

?o TD +atasources 5racle ?o TF '?o TD +atasource( default '?o TD +atasource(

FA +atasources 5racle FA 'FA +atasource(

1&

8/13/2019 Admin Console QuickStart

16/21

default 'FA +atasource(

After selectin the appropriate template, $lick (ON)*N+". Add the appropriate confiurationinformation for the datasource. /efer to the +escription column for information descri%in the use ofeach property. $heck the +n'et%oD if the property !ill not %e used. At the end of your confiurationsession, click 'A" !hich deploys the confiuration information to the server. $lick (AN("L if you

decide not to create the ne! resource.

*f additional modifications to the resources are needed after they are created, simply click on the/esource to %e modified. $lick on the $onfiuration Ta% !here edits to the confiuration propertiescan %e made.

4etric information a%out the +atasource is availa%le from the 4etrics Ta% for the selected +atasource.Additionally, $ontrol 5perations that are availa%le for $onnection 3actories are also availa%le for all+atasource types.

1>

8/13/2019 Admin Console QuickStart

17/21

/3' estinations

"4S +estination resources are also manaea%le via the $onsole. The "4S +estination types are)

Queue Topic

Add New 4!e!e or )opic

To add a ne! "4S +estination resource, select Queue or Topic link under "4S +estinations in the leftnaviation panel. $lick on the KAdd a new reso!rceL %utton on the riht side of your %ro!ser. Theonly template option is the default template of the destination type. Select the default template andclick (ON)*N+"to proceed !ith confiurin your resource. /efer to the +escription column toassist !ith your confiuration entries and the affect each property modifcation has. *f there are defaultvalues for the properties, they !ill %e listed as !ell.

1H

8/13/2019 Admin Console QuickStart

18/21

Throuhput and utili;ation 4etric information are availa%le from the 4etrics Ta% for the selected "4S+estination.

(ontrol Operations

$ontrol 5perations are availa%le for "4S +estination. 3rom the "4S +estination Summary Ta%, selectthe "4S destination to control. This %rins you to the Summary Ta% of the topic or queue. Select the$ontrol Ta%. The 5perations availa%le for topics and queues are)

"3O" All 3essages /emove all messaes from the destination.

')A) Start the +estination

')O,Stop the +estination

List All 3essages 7ist all messaes for the specified su%scription !ith the specified selecto

List !rable 3essages 7ist all dura%le messaes for the specified su%scription !ith thespecified selector

List Non !rable 3essages 7ist all non dura%le messaes for the specified su%scription !iththe specified selector

5perations availa%le specific to queues are)

List 3essage (o!nter As )3L Get the messae counter as T47

List 3essage (o!nter istor2 As )3L Get te essage co!nter istor2 as )3L

eset 3essage (o!nter /eset the messae counter

eset 3essasge (o!nter istor2/eset the messae counter history

5perations availa%le specific to topics are)

1E

8/13/2019 Admin Console QuickStart

19/21

List All '!bscriptions /eturn all su%scriptions for the topic or queue

List All '!bscriptions As )3L /eturn all su%scriptions for the topic or queue in T47

List !rable '!bscriptions /eturn all dura%le su%scriptions for the topic or queue.

List !rable '!bscriptions As )3L/eturn all dura%le su%scriptions for the topic or queuein T47

List Non !rable '!bscriptions /eturn all non dura%le su%scriptions for the topic or queue

List Non !rable '!bscriptions As )3L/eturn all non dura%le su%scriptions for the topicor queue in T47

5nce the $ontrol operation is eDecuted, the 5peration status is returned and listed in the 5perations

istory pane.

1J

8/13/2019 Admin Console QuickStart

20/21

eleting eso!rces

Any resource type can %e +eleted %y naviatin to the /esources:specific Type 'e.., +atasources(Summary Ta% %y simply clickin the "L")"%utton neDt to the name of the /esource you !ant todelete. 5nce the +7T has %een confirmed, the /esource !ill %e removed from the server and !illno loner %e a%le to %e manaed. Iou can al!ays Add the resource aain if needed.

e7erences

The "#oss AS Administration $onsole distri%uted as part of the "#oss Application

Server & release encompasses several open source community pro6ects. The references

%elo! provide additional information on those individual pro6ects. Iour feed%ack isrequested and appreciated. -se the respective forums for discussions related to these

pro6ects and let us kno! of any issues %y filin in the pro6ect "*/A.

m%edded "5/

"#oss Application Server

rofile Service

SA4

/ich 3aces

*f you are runnin "#oss AS .2.D release, you can do!nloadthe m%edded "5/ 1.1.0.GA release totry it out.

20

8/13/2019 Admin Console QuickStart

21/21

'!ar2

This is the first GA release of the "#oss AS Administration $onsole for "#oss AS & %ut the !orkcontinues to provide our development community ease:of:administration and manaement capa%ilities.

Abo!t te A!tor

Shelly 4cGo!anis a mem%er of the "#oss AS development team !orkin from the estford, 4assachusetts nineerin

office. er !ork on the 4#"5/ pro6ect focused on the test desin and development stratey usin "S3-nit. The tests are

included as part of the 4#"5/ pro6ect. 4ore information on the test desin can %e seen on the 4#"5/ QA!iki.

21