
-------------------------------------------------------------------------------
                              README - NCPE LINUX
-------------------------------------------------------------------------------
0 - Before you begin

 Before you begin you should make sure the environment in your SIS server is 
 suitable for the current version of NCPE. 
 You will need:

   0.1 - X/Server running and the ability to launch X client applications;
   0.2 - Java Run Time Environment with version 1.4.2_08;
   0.3 - Which NCPE version corresponds to the LOAD you which to use;


0.1 - Verifying the X/Server access


 You can run ncpe on the SIS in two different ways:

   a) Connected to the SIS native Xserver;
   b) Remotely connected to your desktop (or other) Xserver;

 If you choose to run on the SIS native Xserver, you must have access to the SIS 
 console. 

 You need to login as root on Xserver console to run NCPE. If you login as any 
 other user, make sure you give access to the Xserver to everyone by issuing the
 command 'xhost +' before change to the other user using su or any other way. 
 This will grant everyone access to your Xserver, meaning anyone can launch X 
 client applications on your SIS Xserver. For more on 'xhost' check its man 
 page.

 In addition make sure you have the DISPLAY environment variable correctly set.
 It should be set to:  

     DISPLAY=<Xserver Host Name/IP address>:0.0

 For example if your SIS IP address is 10.10.10.16 then you should have:

     DISPLAY=10.10.10.16:0.0

 This defines the Xserver you which to connect to, in this case the native SIS.

 To test the connection, run any common X client application like xterm. If the
 windows pops on your screen means you can connect to it.

 If you choose to run it remotely connected to your desktop X/Server, you should
 log into the SIS using putty and in that session set the DISPLAY to your 
 desktop IP address.
 Make sure you grant access for connection coming from the SIS server. For this 
 you must check your specific X/Server settings to how to allow/deny access to 
 external connections. 


0.2 - Verifying the JAVA Run Time Environment 


 To check you have the correct java configured issue the following command:

   java -version

 and you should see the following output for version 1.4.2_08:

   java version "1.4.2_08"
   Java(TM) 2 Runtime Environment, Standard Edition (build 1.4.2_08-b03)
   Java HotSpot(TM) Client VM (build 1.4.2_08-b03, mixed mode)

 This is the recommended version for NCPE. It maybe the case you have 
 Recent one like 1.5.0. In this case please have in mind although it 
 should work properly with more recent version, NCPE was built and tested 
 using JDK/JRE 1.4.2.

 In case you can't run the above command the following cases may apply
 to you:

   a)'java' command is not placed in a directory included in 
      your PATH environment variable;
   b) you don't have any version of java installed on SIS;


0.3 - Which NCPE version corresponds to the LOAD you're using


0.3.1.1 - Where to find the ncpe in a Solaris SIS.

 Before everything, take a look on both the load manifest and the load sis patch 
 manifest to know which is the current ncpe package version. In case you have an
 entry for ncpe in the load sis patch manifest you should use this one.

 For example in the .21 load manifest you should find the following line:

  [...]
  ncpe    sol9n_1.4      ncpe-sol9n_1.4.pkg.gz           ncpe9n14   cd1/ncpe
  [...]

 This means the load ncpe version is 1.4.


 After running the setup to download a specific load in your SIS and the 
 corresponding SIS patches, you can find the ncpe under:
   
   /export/home/sis/jumpsrx/ncpe/<version>/...

 And so, for .21 load you should find it under:

   /export/home/sis/jumpsrx/ncpe/1.4/...

 There is no need to further installation steps as long as the load and its 
 patches were successfully downloaded.

0.3.1.2 - How to launch the NCPE in Solaris SIS:

 To run the NCPE cd to /export/home/sis/jumpsrx/ncpe/<version>/bin and issue the 
 command:

   ./ncpe

 This should launch the NCPE in wizard mode. If you want to switch to expert 
 please press the "Expert" button.



0.3.2.1 - Where to find the ncpe in a Linux SIS.

 Before everything, take a look on both the load manifest and the load sis patch 
 manifest to know which is the current ncpe package version. In case you have an
 entry for ncpe in the load sis patch manifest you should use this one.

 For example in the .21 load manifest you should find the following line:

  [...]
  ncpe    10.1-4    ncpe-10.1-4.i586.rpm      ncpe-10.1-4                  cd1
  [...]

 This means this load ncpe version is 10.1-4.

 After running the setup to download a specific load in your SIS and the 
 corresponding SIS patches, you can find the ncpe under:

   /hiq8000-sw/ncpe/ncpe-<version>/...

 and so, for .21 load you should find it under:

   /hiq8000-sw/ncpe/ncpe-10.1-4/...

 There is no need to further installation steps as long as the load is 
 successfully downloaded.

0.3.2.2 - How to launch the NCPE in Linux SIS:

 To run the NCPE cd to /hiq8000-sw/ncpe/ncpe-<version>/bin and issue the command:

   ./ncpe

 This should launch the NCPE in wizard mode. If you want to switch to expert 
 please press the "Expert" button.



----------------------------------------------------------------------------
                        How to use the Wizard Mode
----------------------------------------------------------------------------

In this mode only some absolutely needed node configuration fields are expected
to be fulfilled.

As you click the button next new pages will appear. On some fields, as you 
insert a value you will be changing the value of some dependant non appearing 
fields. That relationship is going to be clarified bellow.

When you reach the end of section 5 it will appear a finish button. Clicking 
there it will be presented the node.cfg file you have just built. You can take 
a look to check it. Clicking "Ok" it appears either a save box or a text box 
Warning you that your node.cfg probably has some errors. 
Is highly recommended to save the node.cfg file in the:

       /hiq8000-sw/config/<node_name> directory. 

Be aware, your node.cfg file must be on that directory the moment you run the 
build-autoinst script.

At any moment you can change to the "Expert Mode" where you will be able to 
change the whole configurable fields. Just keep in mind the dependant relations
(if you change a field which has dependant fields check if these values are 
being changed as you expect).
 
Section 1: (Solution and Hardware)

 You will be asked for the: Product, Hardware Platform, Drive Configuration, 
 RAID Configuration, Ethernet Devices, Cluster Configuration and Software Build 
 ID.

 As you choose your Hardware Platform automatic changes will be made on the 
 Drive Configuration, on the RAID Configuration and in all the ethernet devices 
 options.

Section 2: (Cluster Information)

 You will be asked for the: Cluster and Node Names.

Section 3: (IP Configuration)

 You will be asked for the: Subnet and Netmask IPs for each Network (Management,
 Signaling and Billing), some DNS and NTP fields and for the Default Router, 
 Domain Name and Cluster Name (NMC Configuration).
 As you change the Subnet and the Netmask fields all values related with IP's of
 each network are changed accordingly. If you want to give different values to 
 any of these fields, you can do it on the Expert Mode.

Section 4: (IP Security)

 You will be asked for the IPs of the: SNMP Servers, SMC Servers, SSC Servers, 
 PMC Servers, License Servers, Billing Servers, Billing Clients and some Denial 
 of Service values.

Section 5: (Miscellaneous Assignments)

 You will be asked for some generic values.


Dependencies on the Expert Mode:

 When you change the Hardware Platform (Solution and Hardware 1/2) automatic 
 changes will be made on the Drive Configuration, on the RAID Configuration and 
 in all the ethernet devices options.

 When you change the Netmask (on the top of the IP Configuration 1/7 page) all 
 Netmasks on the IP Configuration pages get that value.
 When you change the Subnet (on the top of the IP Configuration 1/7 page) all 
 the Subnets and dependant IPs on the IP Configuration pages are changed 
 accordingly.

 When you change any subnet (Management, Signaling, Billing or OMNI) you will be
 changing the IPs of that subnet on the IP accordingly (Note: The OMNI IPs on 
 the IP Configuration 5/7 page also change with the OMNI subnet on the 
 IP Configuration 1/6 page.
 
