HighQSoft. Avalon. Service Installation. Version 1.5

Transcription

1 HighQSoft Avalon Version 1.5 Service Installation Andreas Hofmann

2

3 Inhaltsverzeichnis 1 Audience 1 2 Introduction 3 3 System Requirements 5 4 Windows-Installation Language Destination Directory Select Packages The CORBA Naming-Service Database Conguration The Avalon Server Installation of the Files Shortcut Enties Service List Entries Linux-Installation installer Language Destination Directory Select Packages The CORBA Naming-Service Database Conguration The Avalon Server Installation of the Files Shortcut Enties Linux-Installation tgz-le 27 7 Installed Files 29

4 ii INHALTSVERZEICHNIS 7.1 Program Files Conguration Java Archive Logbooks Shell-scripts Verication 31 9 Document History 33

5 Kapitel 1 Audience This document is for people that have to understand the requirements for an Avalon and its installation-details. This document describes the installation of Avalon and the installation or conguration of the CORBA Naming Service for 2 situations: 1) as a MS Windows system services in chapter 4 2) for linux-systems in chapter 5

6 2 Audience

7 Kapitel 2 Introduction Avalon is an ASAM ODS CORBA Server. The successful installation requires the installation of data sources like databases. Avalon uses a driver concept to use dierent data sources, depending on the destination environment. Please read the technical reference sheets for additional information. They are located on CD in the subdirectory docs.

8 4 Introduction

9 Kapitel 3 System Requirements The destination system should have a 2GHz Pentium 4 CPU with 512 MBytes physical memory at least. The software installation requires circa 8 MBytes disk space. These requirement also depended on the planed application and its datastorage. The Avalon server is a CORBA server based on JAVA. Therefore the installation of the Java Runtime System (JRE) is required. The version 1.5 or higher should be installed before starting installation. On 64-Bit Windows packages and packages with current oracle versions the Redistributable Package of Microsoft for Visual Studion 2005 must be installed. The Microsoft Visual C Service Pack 1 Redistributable Package ATL Security Update must be downloaded from Microsoft redistribution download site. You have to select the language and the CPU architacture to download the correct version of the redistribution kit. When oracle is used as the database, take care the oracle client installation is done and the path to the oracle libraries are available for the installation.

10 6 System Requirements

11 Kapitel 4 Windows-Installation The setup.exe located in the root of CD ROM starts the installation process. If you want to update an existing installation, stop the running service before you start installation. 4.1 Language Abbildung 4.1: Select the language Use this window to selected the preferred language.

12 8 Windows-Installation 4.2 Destination Directory The next window describes problems, that can be occurred by the installation. It is possible to overwrite existing environment variables and existing les. If you select an installation directory that already exist, all les that will be installed overwrites the existing les. If you are not sure use an unexisting installation directory to avoid this problem. Abbildung 4.2: Security Hint

13 4.2 Destination Directory 9 Abbildung 4.3: Select Destination Directory

14 10 Windows-Installation 4.3 Select Packages Abbildung 4.4: Select Packages Use this window to select the package to be installed. In the text window below the actual selected package will be described.

15 4.4 The CORBA Naming-Service The CORBA Naming-Service The CORBA Naming-Service (Object-Request-Broker ORB) must be installed in you subnet once at least. The Avalon Server tries to register itself at this Naming Service. The Client tries to nd the Avalon using this service using the naming convention dened by ASAM ODS. It is possible to install this service on the destination system or to use an existing installation of a Naming Service. Use the rst option to request the installation of the Naming Service. In every case you must specify where the Naming Service is running and what port number is used by the service. Ask your system administrator to use a well known Naming Service. For a local installation you can use the default values. Abbildung 4.5: ORB Settings

16 12 Windows-Installation 4.5 Database Conguration In some cases we are able to create the ASAM ODS database, because we know the project. This requires some les to create the database and the necessary table. If you don't see the database conguration window, you are responsable for the ASAM ODS database infrastructure. If the database conguration window is displayed it is recommanded to ll all input elds. It asks for the database system login and the ASAM ODS user login. The "next" button can be used for valid inputs only. Abbildung 4.6: Database Conguration

17 4.6 The Avalon Server The Avalon Server Use this section to congure the Avalon Server as a MS Windows system service. If you don't want to install a service you can start the server by a batch procedure. There are some additionally information needed by the server to serve an ASAM ODS environment. This information will be read from a.ini le and congures the data source and the necessary drivers. If you are installing the server the rst time you can use the default settings but you have to edit the le afterwards. You can nd more information in the chapter Installed Files (p. 29) (see below). Abbildung 4.7: Avalon Conguration

18 14 Windows-Installation 4.7 Installation of the Files The next step copies the les to the destination directroy. Abbildung 4.8: Installation of the Files

19 4.8 Shortcut Enties Shortcut Enties The installation can create some shortcuts to have an easy access to the main functions. The following windows allows you to dene the system menu entry. After the installation there are button to start and stop the Avalon service (if congured) and to uninstall the packages. Abbildung 4.9: Shortcut Entries After the commitment the installation is done. 4.9 Service List Entries If the installation was successfull, there are some entries in the system service list. To check these entries open the service entry from the system->settings menu The services are installed to be started manually after reboot. If you want to change this behavior change the property of the service. Abbildung 4.10: Service System Settings

20 16 Windows-Installation

21 Kapitel 5 Linux-Installation installer The distribution is either a tgz-le or a jar-le. The name of the le gives info about ATHOS-version, ORACLE-version and ORB. The jar-le contains an installer like on Windows. This installer creates an kind of an "private" installation in the directory-tree of the user that is starting the jar-installer. The result is a local installation with an set of shell-scripts that can be used to start ORBD and avalon as programs running in the background. This is convinient for users that need a AVALON for development and experiments. There is some dierences to the windows-installation. The iinitial dierence is that the jar-le is directly started and there is no platform-specic executable that shows the initial splash-screen like on Windows. The tgz-le contains the bare set of les needed for an installation. This les should be used when an AVALON shall be set up that runs for an project. We experience very dierent ways how the system-admins want to setup such systems. Almost every company has a slightly dierent policy here. As a kind of template, there is a subdirectory names SUSE. It contains daemon-startup-le out of a typical installation. The documentation describes both versions (jar and tgz). We start with the jar-type-installation. If you want to update an existing installation, stop the AVALON before you start installation. You can start the installtion in 2 ways: - use a graphical browser to navigate to the location of the jar-file and then double-click on the jarfile - open a terminal-window and execute the command "java -jar <location/filename>" Please excuse that we use the screenshots of the windows-installation. The only dierence would be path-names. Independent on way of invocation, the ow of operations will be as follows:

22 18 Linux-Installation installer 5.1 Language Abbildung 5.1: Select the language Use this window to selected the preferred language. 5.2 Destination Directory The next window describes a problem that can come up during the installation: It is possible to overwrite existing environment variables and existing les. If you select an installation directory that already exist, all les that will be installed overwrites the existing les. If you are not sure, use an not yet existing installation directory to avoid this problem.

23 5.2 Destination Directory 19 Abbildung 5.2: Security Hint

24 20 Linux-Installation installer Abbildung 5.3: Select Destination Directory

25 5.3 Select Packages Select Packages Abbildung 5.4: Select Packages Use this window to select the package to be installed. In the text window below the actual selected package will be described. On Linux, it is recommeded to de-select the service-shortcuts. At current, there is some problems with shortcuts because of some internall handling of g the installer. As said in the initial description: the result of such an installtion on Linux is a local installation that shall be controlled by shell-scripts.

26 22 Linux-Installation installer 5.4 The CORBA Naming-Service On Linux, the term "service" is a bit mis-leading. But we stick with this term because it shall be understood as a type of program that gives services to other programs. The CORBA Naming- Service (Object-Request-Broker ORB) must be installed in your subnet once at least. The Avalon Server tries to register itself at this Naming Service. The Client tries to nd the Avalon using this service using the naming convention dened by ASAM ODS. It is possible to install this service on the destination system or to use an existing installation of a Naming Service. Use the rst option to request the installation of the Naming Service. In every case you must specify where the Naming Service is running and what port number is used by the service. Ask your system administrator to use a well known Naming Service. For a local installation you can use the default values. The result in this type of installation is a shell-script that can be used to start/stop a program running with current users credentials. It is executed runnin in background. In this way, it operates almost like a service on Windows. Abbildung 5.5: ORB Settings

27 5.5 Database Conguration Database Conguration In some cases we are able to create the ASAM ODS database, because we know the project. This requires some les to create the database and the necessary table. If you don't see the database conguration window, you are responsable for the ASAM ODS database infrastructure. If the database conguration window is displayed it is recommanded to ll all input elds. It asks for the database system login and the ASAM ODS user login. The "next" button can be used for valid inputs only. Abbildung 5.6: Database Conguration

28 24 Linux-Installation installer 5.6 The Avalon Server Use this section to congure the Avalon Server. You can start the server by a shell-procedure. (.../scripts4system/avalon.sh) There are some additionally information needed by the AVALON to serve an ASAM ODS environment. This information will be read from a.ini le and congures the data source and the necessary drivers. If you are installing the server the rst time you can use the default settings but you have to edit the le afterwards. You can nd more information in the chapter Installed Files (p. 29) (see below). Abbildung 5.7: Avalon Conguration

29 5.7 Installation of the Files Installation of the Files The next step copies the les to the destination directroy. Abbildung 5.8: Installation of the Files

30 26 Linux-Installation installer 5.8 Shortcut Enties shortcuts shall not be used on Linux at the moment The installation can create some shortcuts to have an easy access to the main functions. The following windows allows you to dene the system menu entry. After the installation there are button to start and stop the Avalon service (if congured) and to uninstall the packages. Abbildung 5.9: Shortcut Entries After the commitment the installation is done.

31 Kapitel 6 Linux-Installation tgz-le The intended audience for this section is sys-admins that know how to install daemons. Avalon will be distributed as tgz-les with a strict name-convention. Example: avalon-bin-linux-amd64-4.1h-ora10.2.tgz This tells me that i have a distribution ˆ for linux ˆ for amd as well as intel-cpus ˆ version 4.1h of athos ˆ compiled to work with oracle 10.2 The tgz-le contains the bare set of les needed for an installation. This les should be used when an AVALON shall be set up dierent to the installer-type-installlation. We experience very dierent ways how the system-admins want to setup such systems. Almost every company has a slightly dierent policy here. If you want to update an existing installation, stop the AVALON before you start installation. The system shall be installed and maintained by an user that is root. A typical location for the installtion could be /opt/<our-project> The token <our-project> is used to have an anonymous term. From here, we assume that this token is "TDCE" By following normal rules in unix-systems, the root of the system was choosen to be in /opt/tdce We recommend to have there the avalon-installation. Please unpack the tgz-le in this directory. In our example, we have a tgz-le named avalon-bin-linux-amd64-4.1h-ora10.2.tgz The package-names ( with version and time/date) will never be used for the invocation of the programs: we use an symbolic link. Example /opt/tdce/app/avalon4.1h -> /opt/tdce/avalon In this way it is possible to keep some versions in parallel and switch very easy between the versions. All examaples from now use the symbolic link but not the real pathname

32 28 Linux-Installation tgz-le The service-denitions for the Avalon-server are in the le /opt/tdce/avalon/etc/athos.ini The avalon nds this le because ATHOS_INI ( in common_settings ) points to this le after execution of common_settings. All installation-activities shall be executed as root. The following sequence shows how to unpack and link this package: /> cd /opt/tdce /> tar xvzf <location-of-tgz>avalon-bin-linux-amd64-4.1h-ora10.2.tgz /> rm avalon /> ln -s avalon4.1h avalon Athos will be installed as subset of Avalon. But there is a symbilc link required: /> cd /opt/tdce /> rm athos /> ln -s avalon/athos athos If you want to have an example how to install ORBD and AVALON as daemon-programs, goto the etc/linux-direcory. there is some example-les and a README. This example-les DO NOT WORK OUT-OF-THE-BOX. It shall be treated as example, not as solution.

33 Kapitel 7 Installed Files This chapter is for windows-users and if you use the installer in Linux. It does not t for the case that you use the tgz-le for installation. After the installation, the following directory structure should be in place: 7.1 Program Files All executables and libraries are located in the subdirectory bin/linux. 7.2 Conguration All le for the conguration are located in the subdirectory etc. Here is the list of the important conguration les: ˆ INI File The INI le for your installation, that describes the running service. This le is used, if you specied to use the included INI le during installation. Which le is used by Avalon is specied by the le AvalonService.cfg. For a detailled description read the document TRS_Avalon.pdf located in subdirectory docs on CD ROM. ˆ aobasexx.htm This le is used by Avalon as the ASAM ODS Basemodel denition. Avalon build the in memory basemodel using this le. Therefore you do not have to change this le. Additionally you can use a HTML browser to have a HTML view of the basemodel. The le is congured in the INI File. the XX denotes the version od ods in use. 7.3 Java Archive The directory jar is used to save all Java Archive Files (jar).

34 30 Installed Files 7.4 Logbooks The subdirectory log contains all log les. There are no log les if the service is not running. ˆ.html The HTML les are the log les of the program that starts Avalon as MS Windows System Service. Depending on the DebugLevel setting, it lists logs of the startup process. If the Avalon is successfully started the last entry must report that the service is running. ˆ.log This log les are the les where the Avalon Server messages are written to. You have to congure the INI to write logs to that le and to change the amount of entries. If Avalon is not congured to write message to that le, the messages are send to the MS Windows system tool EventViewer. 7.5 Shell-scripts The subdirectory Scripts4system contains some les to start/stop ORBD and AVALON.

35 Kapitel 8 Verication To check if the installation was successful, it is recommended todo some tests. Please change to the location that was choosen for installation. If you accept the default, it is $HOME/HighQSoft/Avalon. Change to the directory "Scripts4system". Check if the sh-les are executable. If not, make it executable by applying the command "chmod +x.sh" Try to start the ORBD. Execute the command "./orbd.sh start". This shall start thr ORBD as background process. Check for this process by executing the command "ps ax grep -i orb". It shall show a info like 3539? Sl 0:02 orbd -ORBInitialHost neptun -ORBInitialPort defaultdb /var/log/orb.db -serverid pts/3 S+ 0:00 grep -i orb If the ORBD is running, we can got the next test: start avalon. This can be done in 2 modes: as background or attached to terminal. For the rst test, we want to try an terminal-attached startup. To do this, execute the command./avalon.sh start verbose This shall result in a output like this: Starting the ASAM-ODS Server Avalon (avalon)... / \ \4-1h/ / \ / \ \ / / \ \HighQSoft/ / \ \ /\ \ \ \ / / \/ \\ \ \_/ / \ / \ _ _ \ / _ _ _ \_ The arguments: -NameServiceHost neptun -NameServicePort ServiceName <... name of your service... > start

36 32 Verication verbose :53:52 Avalon will close the session after 30 minutes of inactivity. Avalon fireserviceevent 2 message: [Avalon] STOP_PENDING Avalon fireserviceevent 1 message: [Avalon] START_PENDING [Avalon] ods52.idl is compiled with SunORB 1.5 [Avalon] ORB_CREATION_SUCCESSFUL: ORB was successfully created with arguments <-ORBInitRef=NameService=corbaloc::1.2@neptun:2809/NameService > and with no properties :53: diff: 0 Thread 40f5f940 Session 0 Converting with iconv :53: diff: 0 Thread 40f5f940 Session 0 AoService_Create() :53: diff: 0 Thread 40f5f940 Session 0 options: INIFILE=ATHOS_INI :53: diff: 8 Thread 40f5f940 Session 0 Return AoService_Create(): :53: diff: 0 Thread 40f5f940 Session 0 Use object AoService (0x2aaaaabb7a10) [Avalon] ASAM_ODS_SERVICE_CREATION_SUCCESSFUL: AoService creation successful with following options "INIFILE=ATHOS_INI" [Avalon] ASAM_ODS_FACTORY_CREATION_SUCCESSFUL: Session factory created successfully <... your service...>, <none> Avalon can be started: Servicename: <... your service...> is known, but not valid. [Avalon] HighQSoft Avalon 4_1h running... Host = neptun Service = <... your service...> Corba = SunORB, com.sun.corba.se.impl.orb.orbimpl Avalon fireserviceevent 4 message: [Avalon] RUNNING This is an example of an successful start of AVALON. Next step would be e.g. to access it with AsamCommander. But this is out-of-scope of this document.

37 Kapitel 9 Document History Date Changes Author 14th December 2004 Basic Version Andreas Hofmann

38 Index Installed Files, 29 Linux-Installation, 17, 27 System Requirements, 5 Verication, 31 Windows-Installation, 7