LIP

Document Sample
LIP Powered By Docstoc
					S T A RT
Scheduling Team Automatic Release Tool


Administration guide
Contents
I. Overview .............................. 3                   4. Sesame Authentification ..... 8                  A.     Logout ............................... 14
   A.      Environment ........................ 3        III. Configuration ........................ 9          V. Administration menu ........... 15
   B.      Client context ...................... 3          A.     Module ................................ 9       A.     Settings ............................. 15
     1.    Oracle database .................. 3               1.   Config file ............................ 9        1.   Repositories ...................... 15
     2.    In-house authentication ....... 3                  2.   Repository creation ............. 9               2.   Applications ....................... 16
   C.      Autosys Integration ............. 3                3.   Layout ................................. 9        3.   Users................................. 17
     1.    Read ................................... 3
                                                            B.     Autosys ............................. 10        B.     Reports ............................. 18
     2.    Write.................................... 3        1.   Databases ......................... 10            1.   Missing objects ................. 18
   D.      Architecture ......................... 4           2.   Gateway ............................ 11           2.   Current errors .................... 18
II. Installation ........................... 5                3.   Exec user .......................... 11         C.     Rules ................................. 19
   A.      Apache ................................ 5                                                                 1.   User acceptance test ........ 19
                                                         IV. User menu ......................... 12                  2.   Rule list ............................. 20
     1.    PHP..................................... 6
                                                            A.     Reports ............................. 12          3.   Definitions ......................... 21
     2.    ORACLE client .................... 6               1.   Status done ....................... 12          D.     Housekeeping ................... 22
   B.      Setting up ............................ 7        B.     My account ........................ 13            1.   Purges............................... 22
     1.    PHP Library ......................... 7            1.   Identification ...................... 13
     2.    Application .......................... 7
                                                              2.   Instances........................... 13
     3.    Module installation .............. 8               3.   Applications ....................... 13
 Overview                                                                                                                     3


I.     Overview
This document indicates how the tool has to be installed, configured and maintained.

        A.    Environment
The tool uses an Apache web server with PHP and Oracle database.
Société Générale provides a complete web environment with necessary apache module and PHP extensions.
The tool contains only PHP scripts.

        B.    Client context
              1.     Oracle database
Société Générale focuses on using Oracle database to use its DBA skills.
              2.     In-house authentication
A dedicated team is able to provide authentication through the “Sesame” tool.

        C.    Autosys Integration
              1.     Read
The tool read data from Autosys database with a read only database user, a connection string is provided for each instance.
Only job and job_cond tables are used, this allows to simplify a backward compatibility.
              2.     Write
No information is written directly into the database, an update has to be done exclusively through JIL file.
The security strategy concerns only the publishing, no execution will be realised with the web server account.
JIL file is only sent to a server, integration is done by an Autosys job.




                                                                                                  Launch In Production
        D.     Architecture
This schema shows all components for the tool in order to have a better understanding about communications.
START is a web application hosted on Apache server with PHP
and oracle client.
User communicates with the tool only through http (or https if a
secured communication is required).
The tool gets information from Autosys only by SQL requests.
A repository allows to store information from Autosys in order to
process data.
An Autosys client is used as a gateway between the tool and
Autosys server.
JIL script is inserted with an Autosys client.
 Installation                                                                                                                  5


II.    Installation
        A.      Apache
The prerequisite is an Apache web server to run scripts written in PHP5. Some extensions have to be defined depending on the
modules used.
For the tool, the following extensions are necessary:
       Oracle client
       SOAP and Curl for Sesame authentication
This part was taken over by Société Générale.

Apache account              harprd01

Application account         harprd01

PHP Library                 /HARPRDWEB01/hraprd02/apache_data/gong-he

Publish path                /HARPRDWEB01/hraprd02/apache_data/htdocs

Oracle path                 /usr/local/mount/oracle10204.linux
 Application alias          /home/harprd02

Oracle host                 Hardevbd

Oracle instance             oparhard01

Creation user               HAR$MEP_OWNER

Application user            To be defined




                                                                                      Launch In Production
 Installation

                1.   PHP
A minimum 5.0 PHP version is required by this module.
                2.   ORACLE client
To test the Oracle client and update the password, it is necessary to configure the user environment harprd02 :
  export ORACLE_HOME=/home/harprd02/oracle
  export PATH=$PATH:$ORACLE_HOME/bin
  export LD_LIBRARY_PATH=$ORACLE_HOME/lib
The tnsping can verify the good client communication :
  tnsping oparhard01

  TNS Ping Utility for Linux: Version 10.2.0.4.0 - Production on 03-MAY-2010 14:07:35

  Copyright (c) 1997,      2007, Oracle.   All rights reserved.

  Used parameter files:
  /home/harprd02/oracle/network/admin/sqlnet.ora


  Used TNSNAMES adapter to resolve the alias
  Attempting to contact (DESCRIPTION = (ADDRESS_LIST = (ADDRESS = (PROTOCOL = TCP) (Host = HARDEVBD.fr.world.socgen)
  (Port = 1544))) (CONNECT_DATA = (SID = HARD01)))
  OK (460 msec)
To change the password, it must pass/go through sqlplus :
  sqlplus HAR\$MEP_OWNER/tempo_01@oparhard01
Remarks:
       The account HAR$MEP_OWNER is an account reserved for the creation
       The „$‟ must be protected by braces in case of unix command line.
 Installation                                                                                                          7

         B.     Setting up
                1.    PHP Library
The library functions are provided by Gong-He, it must be installed in a directory not published by Apache.
                2.    Application
The web application hosting the modules, it is directly copied into the publishing directory.
From this stage, we can rely on the environment to check the modules :
http://scheduling/index.php?GHDoc=checkmodules.html
  Extrait la liste des modules mal installés et donne la liste des fonctions non utilisables.
  Extracts the list of modules badly installed and gives the list of non usable functions.

  FTP functions
  Fonctions : GH_ReadFTP, GH_WriteFTP
  Modules :
  Installation :
  Version : 1.0
  Auteur : E. Angenault

  Mail

  Mail functions
  Fonctions : GH_SendMail, GH_MailPart
  Modules :
  Installation :
  Version : 1.0
  Auteur : E. Angenault

  pear

  Pear interface
  Fonctions : GH_SQL
  Modules :
  Installation : pear:DB
  Version : 3.0
  Auteur : E. Angenault




                                                                                                Launch In Production
 Installation

                3.   Module installation
The module is directly put in the directory ATS/LIP.
A group containing the configuration for administrators is created in groups.
http://scheduling




A connection with the admin password allows access to the module as an administrator.
                4.   Sesame Authentification
Authentication can be verified with the script to the following URL :
http://scheduling/index.php?GHDoc=ATS/LIP/install/sesame.html
 Configuration                                                                                                                         9


III.   Configuration
        A.    Module
              1.     Config file
It is necessary to specify the password in the configuration file to access the database.
The information should be entered in the initialization file module: ATS/LIP/config/config.txt
   DBLip oci8://HAR$MEP_OWNER:PASSWORD@oparhard01

              2.     Repository creation
The database schema is in ATS/LIP/install/schema.sql. Tables creation can be executed by the following URL :
http://scheduling/index.php?GHDoc=ATS/LIP/install/create_db.html
When the database is created, we can test the insertion of new records by entering a new request :
http://scheduling/index.php?GHDoc=ATS/LIP/requests/new.html
              3.     Layout
Société Générale uses IE6 which is an obsolete web browser, it requires to change the style sheet accordingly to avoid edge effects.
   /* This is the width you want to be displayed for IE6 users. Remember IE6 can't handle fluid layouts, so it has to be
   fixed. Change it to: 960, 1200, 1440, 1600 (recommended ofc). Now under #content, declare the width with minus 330
   from this value. I used 1600 here so the content is 1600 - 330 = 1270 */

       Screen is limited to 1200px
       Transparency for PNG images is not handled, this can be resolved with javascript or images have to be converted in GIF.




                                                                                                 Launch In Production
 Configuration

          B.   Autosys
All the information about Autosys instances is stored in ATS/LIP/config/instances.tsv
Tsv means “tabulation separated value”, this looks like excel file and can be directly inserted into this kind of application.
There are 5 columns:

Columns                         Description

instance                        Autosys instance name

connection                      Database connection string

prefix                          Table prefix, this string is added before each table name in all sql requests.

input                           Connection string to indicate how and where the JIL file has to be copied.

exec                            Exec user when a job uses Autosys server as target machine.

             1.     Databases
Connection string has the following format:
  oci8://user:password@instance/schema
with
         oci8 : Oracle server (version 8 and above)
         User/password : Database account
         Instance : name of the oracle instance


It is advisable to create an oracle account only able to read the
database.
 Configuration                                                                                                                      11

               2.     Gateway
In order to integrate JIL script into Autosys instance, the file has
to be copied on a server able to process the script. This server
is a gateway, this means a bridge between the tool and
Autosys.
The target is given by another connection string:
  scp://user:password@host/path
with
       User/Password : Unix account
       Host : name of the machine for JIL integration
       Path : Remote directory, this directory is in the home
       directory of the the unix account




You have to prepare the paths on the gateway:                          Ex: you want to use the following target :
   -   Log on to the gateway with the user and password                  Scp://myuser:mypassword@mygateway/ART/inputs
   -   Create a directory with a mkdir                                 You have to do the followings actions :
   -   Create a directory called “rollback” in the previous
                                                                         ssh myuser@mygatwey
       directory                                                         mkdir ART
You can check the result from the START machine :                        mkdir ART/inputs
                                                                         mkdir ART/inputs/rollback
   -   touch test
   -   scp test user@gateway/path
   -   scp test user@gateway/path/roolback
   -
              3.     Exec user
Exec user is the Autosys user able to launch scripts when target machine is the server. This information is used for the transfer
calculation when machine is `hostname`.



                                                                                               Launch In Production
 User menu


IV.   User menu
        A.   Reports
              1.      Status done
Status done lists all requests launched in production.
 User menu                                                                                                                          13

       B. My account
My account contains all the information about the user.
               1.    Identification
Identification concerns user rights on the web server.




             2.     Instances
Instances gives the list of instances allowed, these instances
will be listed in the request form.




             3.     Applications
The application grid shows the rights for each application at
each step of the process.




                                                                 Ex: This user has all rights on each applications except on AGR.




                                                                                        Launch In Production
 User menu

What can I do?
This table shows the rights for each step.
+ indicates that the user has the access.
– indicates that the user has no access.




Mode                                                                    List
                                                                      +(ALL), APP1, APP2…
User has access on applications except a given list of applications
                                                                      -(ALL), +APP1, +APP2
User has no access except for a given list of applications
                                                                      +APP1, +APP2, …,+ APP3,+APP4
User has access or not
        A.   Logout
Logout ends the session.
 Administration menu                                                          15


V.    Administration menu
Administrators have a dedicated toolbar.




       A.    Settings
             1.     Repositories
This page gives an access to the content of the file
ATS/LIP/config/instances.tsv




                                                       Launch In Production
 Administration menu

              2.     Applications
Applications means group of jobs in the same functional scope.
A filter allows to display only the datas corresponding to a mask
for a specific column.
                                                                    Ex : This filter allows to search an application « Autosys » in the
                                                                    column “name”.


3 buttons at the bottom of the grid allow to :
   -   Save the changes
   -   Add a new line
   -   Delete a line
Editing a line is very simple:
   -   Click on the field
   -   Change the value
   -   Click on “Save Changes”
Multiple fields can be modified on several lines, text on changed
lines are changed to bold, a click on the “Save changes” button
allows to update all changes.
To erase a line:
   -   Click on the line
   -   Click on « Delete selected application »
To add a line:
   -   Click in the grid
   -   Click on “Add a new application”
 Administration menu                                                                                                    17

              3.     Users
User grid is very similar to the applications grid and uses the same buttons to save, delete and add a line.




The rights column is a way to view the permissions for the
selected user.
The permissions are limited to instances and applications.
The tool distinguish permissions on source instances and target
instances, this allows to separate people working on the test or
development environment and people able to manage the
production environment.
A user can manage all applications or a list of applications.
The last line is for adding some rights on a new application.
Each time you save permissions, a new line is added by default.
A “Copy from” list is the simplest way to set permissions, you
have just to know a colleague to specify the same rights.




                                                                                                 Launch In Production
 Administration menu

       B. Reports
This page gives some quick views about repository content.
              1.    Missing objects
«Missing objects » report is useful for an Autosys administrator
because it provides a list of all objects requested by a user but
not present in Autosys.
There is two things to do:
   -   Check if the user really need the object
   -   Create the object or update it (ie for a calendar)
              2.     Current errors
The “current errors” gives the list of errors for the current
requests.
 Administration menu                                                                                 19

       C. Rules
Rules are used by the engine to detect standard errors in a job definition.
There is a type for each type of object:
   -   Boxes
   -   Jobs
   -   File watchers
   -   Machines
              1.       User acceptance test
This list is a result of the rules engine check.
The rules engine processes a treatments definitions list with
rules specific to each definition objects.
Each numbered line is a test to detect error in the job
definitions. The job description indicates the line corresponding
to the test number.
If all numbered line are related with a job containing the same
number, the check is complete.
Otherwise, the rule has to be corrected or the job definition is
unable to check the rule.




                                                                              Launch In Production
 Administration menu

                2.   Rule list
This list gives the content of the file stored in ATS/LIP/config.

Boxes                              box_rules.tsv

Jobs                               job_rules.tsv

File watchers                      fw_rules.tsv

Machines                           mac_rules.tsv


The syntax is a sequence of equivalences separated by &, each part compares a field or a sample of field with another field or a string.

Examples                                                                     Description

box_name!=””                                                                 Box name field is not empty

job_name[13]!=B                                                              The 13th character of job name is not a B

alarm_if_fail==1                                                             Alarm if failed is checked

job_name[1-11]!=box_name[1-11]                                               The first 11th characters of the box name and the job name
                                                                             are different

owner!={$exec_user$}                                                         Owner      doesn‟t   contain     exec_user     indicated      in
                                                                             config/instances.tsv

job_name[4]==(M,Q,Y)                                                         The 4th characters M, Q or Y

days_of_week|strpos,\,!=0                                                    Days of week doesn‟t contain a comma

job_name|strlen>60                                                           Job name length contains more than 60 characters
 Administration menu                                                                    21

             3.    Definitions
This grid gives the definitions of the jobs used for the user
acceptance tests.
Each job must have only one error and contains the rule number
in his description field.




                                                                 Launch In Production
        D.    Housekeeping
Housekeeping gives scripts able to maintain the web site.
              1.     Purges
Purges deletes records and files according to log_retention and
tmp_retention in the config file.
JIL scripts are deleted with the same retention as history tables.

				
DOCUMENT INFO
Shared By:
Categories:
Tags:
Stats:
views:8
posted:12/3/2011
language:English
pages:22
liamei12345 liamei12345 http://
About