Doc:latest/tutorial

2010-09-05T16:59:02Z

Pushparaj: /* Creating the csa101 Images */

==Preface==
The ''OpenClovis Sample Application Tutorial'' is a comprehensive tutorial designed to highlight the steps involved in using the OpenClovis software to design and build a high availability system. In this tutorial you will learn to:
* Design a model using the OpenClovis IDE
* Generate code from this model to provide middleware support
* Customize this code for a particular application
* Build and deploy the customized code
* Run the system to see the OpenClovis software in action

===Audience===
 ''OpenClovis Sample Application Tutorial'' is designed for system integrators, designers, and system architects. To use OpenClovis product, you should be aware of the fundamentals of operation, management, and configuration of telecommunication and networking domains. You should also be familiar with C programming, UML notations, and have the basic knowledge of Linux.

 This document assumes that you have installed the OpenClovis SDK, following the installation steps found in the ''OpenClovis Installation Guide''.

===Documentation Conventions===
This guide uses different fonts and symbols to differentiate between document elements and types of information. These conventions are summarized in the following table.
{| border="1" cellpadding="5"
|- style="background:#cdd6e6"
!style="background:#d3e3ff"| Notation
!style="background:#d3e3ff"| Description

|-
|style="background:#ffccaa" | <code><pre>Code</pre></code>
|This font denotes the C code provided in various examples. This font denotes function and variable names.

|-
|style="background:#ffffaa" | <code><pre>Output</pre></code>
|Terminal output.

|-
|style="color:blue" | Cross reference
|This font denotes a hyperlink. You can click on the hyperlink text to access the reference location, which can be either a section within the guide or a URL link. A cross reference refers to a section name and accesses the first page of that section.

|-
| <code>Filenames</code>, <code><DIR></code>
| Files names, Directory paths.

|-
|<code>$ Commands ''group_identifier''</code>
| Commands to be run from a shell. Italic text indicate an argument. This can be replaced with your desired value.
|}

 [[File:OpenClovis_Note.png]]This indicates the presence of notes or annotations, related to the context of the document.
 [[File:OpenClovis_Caution.png]]This indicates that certain precautionary measures must be taken before performing a particular task.
 [[File:OpenClovis_Info.png]]This indicates that additional information is provided to you.

As mentioned in the ''OpenClovis Installation Guide'' the default directory for installation is <code>/opt/clovis</code> for root installation and <code>$HOME/clovis</code> for non root users. Throughout this document we will use <code><install_dir></code> to refer to the installation directory.

===Related Documents===
For additional information about OpenClovis products, please refer to the following guides:
* '''OpenClovis Release Notes''' provides information about the software and the hardware required to install OpenClovis Application Service Platform (SAFplus Platform) and Integrated Development Environment (IDE). It contains the additional features and enhancements of the product since the previous release. It also summarizes the issues and limitations of the product and provides workarounds wherever applicable.
* '''OpenClovis SA Forum Compliance''' describes the level of compliance of OpenClovis SAFplus Platform and its Application Programming Interface (API) with the relevant Service Availability Forum Specifications.
* '''OpenClovis Installation Guide''' provides the system requirements, installation procedure for OpenClovis SAFplus Platform, IDE, and the Evaluation System.
* '''OpenClovis Evaluation System User Guide''' provides all the required information to configure and run the sample models packaged within the Evaluation System. This document also provides good understanding of OpenClovis SAFplus Platform's functionality. This is the natural follow on to the ''OpenClovis Sample Application Tutorial'' as it builds on the example created in that document.
* '''OpenClovis SDK User Guide''' provides information about OpenClovis Application Service Platform (SAFplus Platform) architecture, various OpenClovis SAFplus Platform components, and their interactions. This guide helps you to configure the OpenClovis SAFplus Platform components, compile, and execute the OpenClovis SAFplus Platform code to build your custom application.
* '''OpenClovis IDE User Guide''' describes the usage of Integrated Development Environment (IDE), a graphical development environment that complements the SAFplus Platform platform. This guide helps you to understand how to use the various features of the IDE to build the application.
* '''OpenClovis Log Tool User Guide''' provides information about the usage of OpenClovis Log Tool. OpenClovis Log Tool is an interactive utility that allows you to view binary log files in a readable format and hence monitor system errors, warnings, and other log information. Log Tool allows you to format the <code>.log</code> files and filter them to view the required entries.
* '''OpenClovis API Reference Guide''' is provided for each component. It describes the Application Programming Interface (API), Service Model, and Management Information Model of the various OpenClovis Application Service Platform (SAFplus Platform) services. It helps the developer to understand the capabilities of the SAFplus Platform services and the APIs provided by these services.
* '''OpenClovis SAFplus Platform Console Reference Guide''' provides details about managing applications built on OpenClovis SAFplus Platform using the SAFplus Platform runtime debug console commands. SAFplus Platform Console commands can be used to manage, monitor, and test your application.

===OpenClovis Online Technical Support===
OpenClovis customers and partners can register on our Web site and receive personalized services and information. If you need any support or assistance while working on OpenClovis products, you can access the following: URL: http://www.openclovis.com. Send your queries to: support@openclovis.com. Open source community support is available at: http://www.openclovis.org/forum.

===Documentation Feedback===
We are interested in hearing from our customers on the documentation provided with the product. Let us know your comments and suggestions on improving the documentation at OpenClovis Inc. Send your comments to: support@openclovis.com. Post your feedback on documentation at: http://www.openclovis.org/forum.

==Our Example: The csa101 System==
The ''OpenClovis Sample Application Tutorial'' will take you through a series of examples each introducing a key concept of the product. Each example builds on the example before it so it is important to go through them in order. The examples are named so that it is easy to determine their sequence. The examples all begin with the letters '''csa''' (standing for Clovis Sample Application) and end with a number. Our first example will be '''csa101'''.

The purpose of our first example is to highlight basic component management. It introduces the basic skeleton of an OpenClovis Application Service Platform (SAFplus Platform) based application component and illustrates how it interacts with the System. It demonstrates basic component registration and life-cycle management.

We will keep this first example very simple. It will consist of the OpenClovis SAFplus Platform running a small component named '''csa101'''. All that this component will do is continuously print 'Hello World!' to a log file. While this component is not very exciting, it will allow us to easily see when the application is in a running state and when it is not. This will allow us to focus on the infrastructure of SAFplus Platform and how the application interfaces with it.

For this example we will assume that we have a chassis with five slots. We will have one type of blade in our example, a '''System Controller'''.
 [[File:OpenClovis_Note.png]]With the type of model we are developing we would typically define two blade types to install in these slots. The first blade type would be a '''System Controller''' blade (which is responsible for running the OpenClovis software which manages application startup, shutdown, failover, etc.) and the second blade type would be a '''Payload''' blade (which is responsible for running our custom '''csa101''' application). However, for the purpose of simplifying the deployment of our system, we will define only the '''System Controller''' blade type and have both the SAFplus Platform and component application run on this one blade. This will allow the example to be run on a single PC.

==Creating the csa101 Model==
The first step in setting up our example is to create a model which represents the system that we will eventually deploy. This is done through the '''OpenClovis IDE'''. In this chapter we will step through the following tasks:
* Create a project area
* Launch the '''OpenClovis IDE'''
* Create the IDE project
* Specify the Resource model (the types of physical hardware in our system)
* Specify the Component model (the types of components or applications in our system)
* Specify which Components run on which Resources
* Specify important build and boot parameters

===Creating a New Project Area===
A project area is a directory on your system where you can develop OpenClovis models and generate the code corresponding to those models. The project area can hold multiple models allowing you to manage all of your models in one location. All the models in the same project area share the same SAFplus Platform source tree. This way any modifications made to the SAFplus Platform source tree are re-used across all the models that were created in that project area.

You create a project area using a script from the command line. To create a project area named '''projectarea1''' in the '''/home/clovis''' directory you should execute the following command:
<code><pre>
# cl-create-project-area /home/clovis/projectarea1
</pre></code>

===Launching the OpenClovis IDE===
You can launch the '''OpenClovis IDE''' from the command line. If you chose to create symbolic links during installation you can simply enter <code>'''cl-ide'''</code> from any directory. If you did not create symbolic links during installation you can either:

<ul>
<li>Add the installation directory to the shells search path and then launch the IDE. For example with a bash shell,
<code><pre>
# export PATH=$PATH:$install_dir/sdk-5.0/bin
# cl-ide
</pre></code>
or
<li>Execute the command
<code><pre>
# <install_dir>/sdk-5.0/bin/cl-ide
</pre></code>
</ul>

The splash screen for OpenClovis IDE is displayed as illustrated in Figure [[#OpenClovis IDE Opening Screen | OpenClovis IDE Opening Screen]].

[[File:Tutorial_GettingStartedIDE_OpeningScreen.png|frame|center| '''OpenClovis IDE Opening Screen''' ]]

You will then be prompted to select a workspace in which to do your work as illustrated in Figure [[#OpenClovis IDE Workspace Launcher | OpenClovis IDE Workspace Launcher]].

[[File:Tutorial_GettingStartedIDE_WorkspaceLauncher.png|frame|center| '''OpenClovis IDE Workspace Launcher''' ]]

The workspace you select should correspond to the project area that you created in the previous section (in this case "/home/clovis/projectarea1"). Note that the workspace includes a subdirectory of "/ide_workspace". This is done strictly for organizational purposes. It keeps the IDE models separate from the generated SAFplus Platform models and code.
<ul>
<li>Select the workspace and click '''OK''' to launch OpenClovis IDE as illustrated in the Figure [[#OpenClovis IDE Welcome Screen | OpenClovis IDE Welcome Screen]].
</ul>

[[File:Tutorial_WelcomeScreen.png|frame|center| '''OpenClovis IDE Welcome Screen''' ]]

The '''OpenClovis''' IDE is launched and you are now looking at the main work area. For more information about the components of this main work area including the OpenClovis IDE menu and toolbar, see ''OpenClovis IDE User Guide''.

===Creating the Sample Project===
We will now create a project within the '''OpenClovis IDE'''. This project will hold both the resource model and the component model for our example system. The resource model is a physical view of the resources (the chassis, the blade types, etc.) in our system. The component model is a logical view of the components (applications, etc.) in our system.

We will be using the '''New Project Wizard''' to create our project. The wizard captures some high-level information about the system that we are building and performs a lot of the basic setup for us.

[[File:OpenClovis_Note.png]]The same model that we are building through the wizard could also be created manually through the Resource and Component Editors. For more information on the Resource and Component Editors see ''OpenClovis IDE User Guide''.

To launch the '''New Project Wizard''' select '''File''' > '''New''' > '''Project''' from the IDE menu bar.

The '''New Project Wizard''' is displayed and '''Clovis System Project''' is selected by default as illustrated in Figure [[#New Project Wizard | New Project Wizard]].

[[File:Tutorial_GettingStartedIDE_NewProjectWizard.png|frame|center| '''New Project Wizard''' ]]

Click '''Next'''. The '''Clovis System Project''' window is displayed as illustrated in Figure [[#Clovis System Project | Clovis System Project]].

[[File:Tutorial_NewProject.png|frame|center| '''Clovis System Project''' ]]

Enter the following information:

<ul>
<li>'''Project Name''' : Enter the name of your new project as '''SampleModel'''.
 [[File:OpenClovis_Note.png]]Do not use spaces or special characters for the project name. The project name can be alphanumeric, but cannot start with a number or have only numbers.
 Select '''Use default''' to use the same directory mentioned in the '''Directory''' field.

<li>'''SDK Location''': Enter the location where the OpenClovis SDK was installed. For e.g. if the SDK was installed at location /opt/clovis, then the SDK location is /opt/clovis/sdk-<version>.

<li>'''Project Area Location''': Enter the location where the generated source code for the model should be stored.
 [[File:OpenClovis_Note.png]]This can be any existing directory but is usually the project area that was created in the previous section.

<li>'''Python Location''': Enter the location where Python 2.5.0 is installed on your system. If Python 2.5.0 was installed by OpenClovis SDK, the directory is <code>'''<installation_directory>/buildtools/local/bin'''</code>.
</ul>

Click '''Next'''. The '''Add New Blade Type''' window is displayed. This dialog is used to define the blade types that are in our system.

[[File:Tutorial_AddBlade.png|frame|center| '''Add New Blade Type''' ]]

Remember that the system we are modelling has only one blade type...a System Controller.
<ul>
<li>Use the '''Add''' button to add a new blade type to the list. Name this blade type 'SysBlade' (for System Controller blade).
</ul>

Click '''Next'''. The '''Add New SAF Node Type''' window is displayed. This dialog is used to define the type of logical node that will be run on the corresponding blade type defined in the previous dialog.

[[File:Tutorial_AddNode.png|frame|center| '''Add New SAF Node Type''' ]]

Node types represent groups of software. They are classified as either a System Controller class or a Payload class. This distinction gives the node type certain characteristics which cause it to behave in a well-defined manner. Since we have only a System Controller in our system we will add a node type of class System Controller.

<ul>
<li>Use the '''Add''' button to add a new node type to the list. Name the node type 'SCNode' and ensure that its node class is 'System Controller (SAF Class B)'.
</ul>

Click '''Next'''. The '''Specify Program Names''' window is displayed. This dialog is used to create programs or SAF Service Types and associate them with the SAF Node Types specified in the previous dialog.

[[File:Tutorial_DefineProgramNames.png|frame|center| '''Specify Program Names''' ]]

In our system we need one SAF Service Type which represents our high availability software (csa101 that continously prints "Hello World!").

<ul>
<li>Use the '''Add''' button to add a program name to the list. Change the program name to 'csa101' and associate the program with the 'SCNode' node type.
</ul>

Click '''Finish'''. This will create the sample model using the blade type, node type, and program name information collected through the 'New Project Wizard' dialogs.

===Viewing the Model===

====The OpenClovis IDE Perspective====
Once the wizard pages are closed you will be returned to the main IDE view also known as the '''OpenClovis IDE Perspective'''. On the left hand side of this view you will see the '''Clovis Workspace''' pane which contains the new project you just created with all project related files and folders. The folders are displayed based on your filter settings. With the default filter settings, the folders shown in Figure [[#Clovis Workspace|Clovis Workspace]] is displayed in the '''Clovis Workspace''' pane. For information about filter settings, refer ''OpenClovis IDE User Guide''.

[[File:Tutorial_GettingStartedIDE_ClovisWorkspace.png|frame|center|Clovis Workspace]]

By default, the '''Resource''' and '''Component''' Editor views are available for the created project. To view them, click '''Clovis''' on the menu bar at the top of the screen and select '''Resource Editor''' or '''Component Editor''' from the menu. You can also click '''Resource Editor''' or '''Component Editor''' icons from the tool bar as shown in Figure [[#OpenClovis IDE Tool Bar | OpenClovis IDE Tool Bar]].

[[File:Tutorial_Toolbar.png|frame|center| '''OpenClovis IDE Tool Bar''' ]]

====Resource Editor View====
The '''Resource Editor''' shows the types of physical objects in our system. It gives us a place to create new objects and interact with the objects that already exist. The '''Resource Editor''' view for our model should look similar to the following figure.

[[File:Tutorial_ResourceEditor.png|frame|center| '''OpenClovis Resource Editor''' ]]

This editor always has a '''Chassis''' object which is the root of all other objects in the editor. In our case it also has the '''SysBlade''' blade type that we created through the '''Project Creation Wizard'''. You will also notice that the '''SysBlade''' is attached to the '''Chassis''' using a '''Composition''' relationship indicating that '''SysBlade'''s reside within the '''Chassis'''.

On the right hand side of the editor view you will see the '''Palette''' which can be expanded and collapsed. Expanding the '''Palette''' you will see the list of objects that can be dragged onto the editor view to add to our model. Once an object is on the editor view you can view and change its properties by right clicking on the object and selecting '''Properties...''' from the context menu.

For more information about the '''Resource Editor''' view see ''OpenClovis IDE User Guide''.

====Component Editor View====
The '''Component Editor''' shows the types of logical objects in our system. It gives us a place to create new objects and interact with the objects that already exist. The '''Component Editor''' view for our model should look similar to the following figure.

[[File:Tutorial_ComponentEditor.png|frame|center| '''OpenClovis Component Editor''' ]]

This editor always has a '''Cluster''' object which is the root of all other objects in the editor. In our case it also has the '''SCNode''' node type and the '''csa101''' SAF Service Type (a combination of Service Group, Service Unit, Service Instance, Component Service Instance, and SAF Component) that we created through the '''Project Creation Wizard'''. These have all been automatically attached in a way that makes a working model.

On the right hand side of the editor view you will see the '''Palette''' which can be expanded and collapsed. Expanding the '''Palette''' you will see the list of objects that can be dragged onto the editor view to add to our model. Once an object is on the editor view you can view and change its properties by right clicking on the object and selecting '''Properties...''' from the context menu.

For more information about the '''Component Editor''' view see ''OpenClovis IDE User Guide''.

===Configuring the Components===
The '''New Project Wizard''' that we used to create our project configured the system using the most common options. We will have to make a few changes to this model in order for our example to work. We will make these changes in the '''Component Editor''' view.

In the Component Editor you will notice seven different objects that were created by the wizard. The first two of these are:
<ul>
<li>Cluster: The root object of all other objects in the Component Editor view.
<li>SCNode: This is the SAF Node Type that we specified during project creation.
</ul>

The next five objects all make up the Program or SAF Service Type that we specified on the last dialog of the New Project Wizard. These objects are:

<ul>
<li>csa101SG: This is the Service Group representing our high availability software component.
<li>csa101SU: This is the Service Unit that is logically associated with the SCNode SAF Node Type.
<li>csa101SI: This is the Service Instance
<li>csa101CSI: This is the Component Service Instance
<li>csa101: This is the SAF Component which represents our program or executable.
</ul>

We will be making changes to the Service Group (csa101SG), the Service Instance (csa101SI), and the SAF Component (csa101).

====Configuring the Service Group====
To make changes to the Service Group double-click on the box titled '''csa101SG'''. The '''Service Group Details''' dialog is displayed.

[[File:Tutorial_ServiceGroupDetails.png|frame|center| '''Service Group Details''' ]]

<ul>
<li>The first change we want to make is to the '''Redundancy Model'''. The '''Redundancy Model''' is the strategy that is used by the SAFplus Platform system to recover from a node failure. For our simple model (which only has one node) we are not going to rely on any failover recovery so change the '''Redundancy Model''' to 'No Redundancy' as shown.
 [[File:OpenClovis_Note.png]]You will notice that when you change the redundancy model some of the other fields are modified automatically and become read-only. This is to ensure integrity of the redundancy models.

<li>The second change that we want to make is to the '''Admin State'''. The '''Admin State''' defines the state of the component when the system is first brought up. In our case we want to change the '''Admin State''' to be 'Locked Initialized'. This means that when the system first starts up this '''Service Group''' (and its subcomponents) will be initialized but not yet put into a running state. So our csa101 application will not yet start printing "Hello World!".

<li>When you are finished making the changes click the '''OK''' button to commit the changes.
</ul>

====Configuring the Service Instance====
To make changes to the Service Instance double-click on the box titled '''csa101SI'''. The '''Service Instance Details''' dialog is displayed.

[[File:Tutorial_ServiceInstanceDetails.png|frame|center| '''Service Instance Details''' ]]

<ul>
<li>The only change we want to make here is to the '''Number of standby assignments'''. This value represents the number of components that will be waiting to take over during a node failure and goes hand-in-hand with the '''Redundancy Model''' that we selected for the Service Group. Since we selected 'No Redundancy' for our '''Redundancy Model''' we need to set this value to 0...since we are not supporting any failover in this model.

<li>When you are finished making the changes click the '''OK''' button to commit the changes.
</ul>

====Configuring the SAF Component====
To make changes to the SAF Component double-click on the box titled '''csa101'''. The '''SAF Component Details''' dialog is displayed.

[[File:Tutorial_SAFComponentDetails.png|frame|center| '''SAF Component Details''' ]]

The SAF Component represents our high availabilty program or executable. We need to pass a command line argument to this executable. The reason for this argument is to force the program to print the 'Hello World!' output to a special log file for our viewing. We will look at this more closely when we customize our code.

<ul>
<li>To add command line parameters click the '''Edit...''' button corresponding to the '''Command line Arguments''' label.
</ul>

The '''Command line Argument Details''' dialog is displayed.

[[File:Tutorial_CommandLineArgs.png|frame|center| '''Command line Argument Details''' ]]

<ul>
<li>Click the '''New''' button to add a new value to the list.
<li>Click on the new value in the list and it will become editable. Change the value to '''-p'''.
<li>Click the '''OK''' button to save and close the dialog.
<li>Click the '''OK''' button on the '''SAF Component Details''' dialog to commit the changes to the SAF Component and close the dialog.
<li>Save the component model using the '''File > Save''' menu item.
</ul>

===Configuring Physical Instances===
The configuration of our logical models is complete. During this process we have defined all of the 'types' of objects in our system. Now it is time to configure actual instances of those objects so that they can be built and deployed.

Object instance configuration is done through the Availability Management Framework (AMF) via the '''AMF Configuration''' dialog.

<ul>
<li>To launch this dialog go to the the '''Clovis''' menu and select '''AMF Configuration...'''
</ul>

The '''AMF Configuration''' dialog is displayed.

[[File:Tutorial_AMFConfig.png|frame|center| '''AMF Configuration Dialog''' ]]

You will note from the instructions on this page that the physical instances representing the objects in our model can be created manually or by using wizards. Using the wizards will save us both typing and time so we will use these instead of creating each instance manually.

====Creating Node Instances====
First we will create actual instances of the Node Types (in our case only one Node Type...SCNode) we created in our model.

<ul>
<li>Double-click AMF Configuration in the left hand pane. The Node Instance List appears.
<li>Click on Node Instance List. The right hand pane displays the fields we must fill out to create our node instance.
</ul>

In the right hand pane:

<ul>
<li>Select SCNode for the '''Node Type'''.
<li>Select SysBlade for the '''Blade type'''.
<li>Enter 1 for the '''Node Count'''.
</ul>

The complete form should look like the following.

[[File:Tutorial_AMFNodeWizardDetails.png|frame|center| '''Node Wizard Details''' ]]

<ul>
<li>Click the '''Create Instance Tree''' button to create our node instance.
</ul>

Expanding the '''Node Instance List''' branch of the '''AMF Configuration''' tree in the left-hand pane reveals a new node instance named SCNodeI0 (indicating SCNode Instance 0).

====Creating Service Group Instances====
Now we will create actual instances of the Service Groups that we defined in our model.

<ul>
<li>Click on Service Group List. The right hand pane displays the fields we must fill out to create our service group instance.
</ul>

In the right hand pane:

<ul>
<li>Select csa101SG (the only service group type we defined) for the '''Service Group Type'''.
*The '''Associated Node Instances''' list will be populated with all of the node instances that can be associated with the selected service group type.
<li>Select SCNodeI0 from the '''Associated Node Instances''' list.
</ul>

The completed form should look like the following.

[[File:Tutorial_AMFSGWizardDetails.png|frame|center| '''Service Group Wizard Details''' ]]

<ul>
<li>Click the '''Create Instance Tree''' button to create our service group instance.
</ul>

 
If you now completely expand the '''AMF Configuration''' branch of the tree in the left-hand pane you will see the following.

[[File:Tutorial_AMSConfigDetails.png|frame|center| '''AMF Configuration Instance Details''' ]]

Notice that not only have the wizards created the node and service group instances for you, they have also filled out the entire instance tree. This was accomplished based on two key sets of information. The first of these is the association that was made between the service group type and the node instance in the '''Service Group Wizard'''. The second set of information is the component model that we created through the New Project Wizard and the Component Editor.

 [[File:OpenClovis_Note.png]]For more information regarding the specific properties of the generated instances see [[#Appendix B: AMF Configuration Instance Details|Appendix B: AMF Configuration Instance Details]].

 
Thats it. We are done modelling the csa101 example!
<ul>
<li>Click the OK button to commit our changes and close the dialog.
</ul>
Now its time to generate the framework code.

==Generating the csa101 Code==
In this step we generate the source code for our example. The code that will be created is the framework code that handles all of the low level functionality provided by OpenClovis.

To generate the source code go to the '''Project''' menu and select '''Generate Source'''. Several progress dialogs will appear and after a few seconds code generation will be complete.

The source code and configuration XML files are generated and placed in subdirectories of the '''Project Area Location''' that we specified in the '''New Project Wizard'''. You can review this location by using the '''Project > Properties''' menu to get to the '''Project Properties''' dialog and then selecting '''Clovis System Project''' in the left hand pane.

You can review the generated code from within the OpenClovis IDE. To do this go to the '''Clovis Workspace''' pane and expand the '''SampleModel''' node. The node tree should look like the following.

[[File:Tutorial_CWCodeTree.png|frame|center| '''Clovis Workspace Code Tree''' ]]

The code of particular interest to our example is in the SampleModel/src/app/csa101 branch of the tree. This is the code for our csa101 example. The csa101 example consists of two C modules (<code>clCompAppMain.c</code> and <code>clCompCfg.c</code>) and two header files. There is also a make file that will be used for building the application. The <code>clCompAppMain.c</code> file implements our 'Hello World!' application.

 [[File:OpenClovis_Note.png]]If you run code generation a second time you will be presented with a dialog box asking if you would like to make a backup copy of the existing source code before proceeding. You can answer No to this dialog.

==Customizing the csa101 Code==
While the code that was generated in the previous section can be built and run we want to make some changes to it so that we can easily see what our example is doing. For our example we will be changing one source file (<code>clCompAppMain.c</code>) and two make files.
 [[File:OpenClovis_Note.png]]In a real production situation this is the point where you would customize the code to perform the specific tasks of your product.

You will notice in the C file that there are several places where you see the following comment block.

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffccaa;" align="center"|clCompAppMain.c
|-
|<code><pre>

/*
---BEGIN_APPLICATION_CODE---
*/

// ...

/*
---END_APPLICATION_CODE---
*/
</pre></code>
|}

Makefiles have a similar convention but with a slightly different syntax.

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffccaa;" align="center"|Makefile
|-
|<code><pre>

# ---BEGIN_APPLICATION_CODE---

# ---END_APPLICATION_CODE---
</pre></code>
|}

These are sections of the file where it is safe to enter custom application code without having to worry about that code being overwritten if you were to again perform '''Generate Source''' for your model. This is important since the typical development cycle is an iterative process where you will return to the IDE to make modifications to your model.

To simplify the process of building and running the csa101 example, OpenClovis has already made the necessary code customizations and shipped this code with the OpenClovis SDK. At this point you can simply replace the generated source files with these customized versions to avoid typing in the changes. We will go over each customization below and explain what was done.

To replace the generated files with the customized versions shipped with the OpenClovis SDK follow these instructions.
 [[File:OpenClovis_Note.png]] The sample applications containing the csa101 example can be found under the installation directory at <code><install_dir>/sdk-5.0/src/examples/eval</code>. We will refer to this directory in the remaining of this section as <code><eval_dir></code>.

<ol>
<li>Exit the OpenClovis IDE using the '''File > Exit''' menu item. If you are prompted to save changes before exiting answer yes.
<li>Navigate to the source code work area.
<code><pre># cd /home/clovis/projectarea1/ide_workspace/SampleModel/src/app</pre></code>
<li>Using your favorite editor open the file <code>Makefile</code> that resides in this directory. This is the application make file.
<li>Add the following line to this file within the first <code>BEGIN_APPLICATION_CODE</code> and <code>END_APPLICATION_CODE</code> comment block.
<code><pre>SUBDIRS += ev</pre></code>
This will instruct the build process to build our custom output library.
<li>Save this file and exit the editor.
<li>Execute the following command to copy the output package to our working area.
<code><pre># cp -r <eval_dir>/src/app/ev .</pre></code>
<li>Navigate to the component code work area.
<code><pre># cd csa101</pre></code>
<li>Execute the following command to copy the csa101 source code.
<code><pre># cp <eval_dir>/src/app/csa101/clCompAppMain.c .</pre></code>
<li>Execute the following command to copy the component make file.
<code><pre># cp <eval_dir>/src/app/csa101/Makefile .</pre></code>
<li>Restart the OpenClovis IDE.
<code><pre># cl-ide</pre></code>
</ol>

===Customizing clCompAppMain.c===
The <code>clCompAppMain.c</code> file is the C module which will implement our 'Hello World!' behavior. We have to make changes in several parts of this file.
 [[File:OpenClovis_Note.png]]If you copied the files as instructed in the section above then these changes have already been made to the files. Use this section to review and understand the changes.

<ol>
<li>In the include section of this file we have added a new include for <code>ev.h</code>. This refers to a special output library that we copied to our work area in the previous section. This output library is used to redirect output from the application to a component specific log. This is purely cosmetic but it will allow us to easily monitor what is happening when we run our example. (The following code begins at line 44 of the source file.)

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffccaa;" align="center"|clCompAppMain.c
|-
|<code><pre>
/*
---BEGIN_APPLICATION_CODE---
*/

#include "clCompAppMain.h"
#include "../ev/ev.h"

/*
---END_APPLICATION_CODE---
*/
</pre></code>
|}

<li>Next we define a couple of static variables that will keep track of the state of our application and a function to aid in showing when the application is running. (The following code begins at line 79 of the source file.)

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffccaa;" align="center"|clCompAppMain.c
|-
|<code><pre>
/*
---BEGIN_APPLICATION_CODE---
*/

static int running = 0;
static int exiting = 0;

static char*
show_progress(void)
{
static char bar[] = " .";
static int progress = 0;

/* Show a little progress bar */
return &bar[sizeof(bar)-2-(progress++)%(sizeof(bar)-2)];
}

/*
---END_APPLICATION_CODE---
*/
</pre></code>
|}

The <code>running</code> flag will be used to indicate whether the current application is active or suspended while <code>exiting</code> is a flag that indicates that the main() function returns, causing the exit of the application.

The function <code>show_progress</code> returns a pointer to a c string with a number of spaces followed by a '.' character. The number of spaces in the string cycles from zero to an upper bound. This is used later on to provide visual indication of the progress of the application's output.

<li>Next we have added a function <code>hello_func</code> to print the output. (The following code begins at line 118 of the source file.)

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffccaa;" align="center"|clCompAppMain.c
|-
|<code><pre>

void *hello_func(void *unused)
{
while (!exiting)
{
if (running)
{
clprintf(CL_LOG_SEV_INFO, "csa101: Hello World! %s\n", show_progress());
}
sleep(1);
}

return NULL;
}

</pre></code>
|}

Notice the while loop condition. This function uses the <code>exiting</code> variable that was initialized to 0. The loop will keep running until <code>exiting</code> is set to non-zero. The if condition within the while loop checks the value of the <code>running</code> variable. The work of the application: printing "Hello World!" along with the progress indicator will only be done when the <code>running</code> variable is set non-zero. Next the command <code>sleep(1)</code> simply sleeps for a second so as not to fill log files too quickly or completely swamp the CPU.

When <code>exiting</code> becomes non-zero, we return from the function.

<li>Next we have added a function to initialize the special output library mentioned earlier (which is at line 245 in the source file).

<li>Next we create a thread and call the function <code>hello_func</code> in the new thread context. (The following code begins at line 252 of the source file.)

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffccaa;" align="center"|clCompAppMain.c
|-
|<code><pre>
/*
* ---BEGIN_APPLICATION_CODE---
*/
clprintf(CL_LOG_SEV_INFO, "csa101: Instantiated as component instance %s.\n", appName.value);

clprintf(CL_LOG_SEV_INFO, "%s: Waiting for CSI assignment...\n", appName.value);

rc = clOsalTaskCreateDetached("hello_thread", CL_OSAL_SCHED_OTHER, CL_OSAL_THREAD_PRI_NOT_APPLICABLE, 0, hello_func, NULL);
CL_ASSERT(rc == CL_OK);

/*
* ---END_APPLICATION_CODE---
*/

</pre></code>
|}

<li>Next we indicate to our app when we are exiting. (The following code begins at line 284 of the source file.)

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffccaa;" align="center"|clCompAppMain.c
|-
|<code><pre>
/*
* ---BEGIN_APPLICATION_CODE---
*/

exiting = 1;
clEvalAppLogStreamClose(gEvalLogStream);

/*
* ---END_APPLICATION_CODE---
*/

</pre></code>
|}

We set the <code>exiting</code> variable to 1. This will cause the loop in our <code>hello_func</code> function to exit.

<li>Next we will put in code to manage the state of our application. (The following code begins at line 453 of the source file.)

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffccaa;" align="center"|clCompAppMain.c
|-
|<code><pre>
void clCompAppAMFCSISet(SaInvocationT invocation,
const SaNameT *compName,
SaAmfHAStateT haState,
SaAmfCSIDescriptorT csiDescriptor)
{
/*
* ---BEGIN_APPLICATION_CODE---
*/

// ...

/*
* ---END_APPLICATION_CODE---
*/

/*
* Print information about the CSI Set
*/

clprintf (CL_LOG_SEV_INFO, "Component [%.*s] : PID [%d]. CSI Set Received\n",
compName->length, compName->value, mypid);

clCompAppAMFPrintCSI(csiDescriptor, haState);

/*
* Take appropriate action based on state
*/

switch ( haState )
{
case SA_AMF_HA_ACTIVE:
{
/*
* AMF has requested application to take the active HA state
* for the CSI.
*/

/*
* ---BEGIN_APPLICATION_CODE---
*/

clprintf(CL_LOG_SEV_INFO, "csa101: ACTIVE state requested; activating service\n");
running = 1;

/*
* ---END_APPLICATION_CODE---
*/

saAmfResponse(amfHandle, invocation, SA_AIS_OK);
break;
}

</pre></code>
|}

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffccaa;" align="center"|clCompAppMain.c
|-
|<code><pre>

case SA_AMF_HA_STANDBY:
{
/*
* AMF has requested application to take the standby HA state
* for this CSI.
*/

/*
* ---BEGIN_APPLICATION_CODE---
*/

clprintf(CL_LOG_SEV_INFO, "csa101: New state is not the ACTIVE; deactivating service\n");
running = 0;

/*
* ---END_APPLICATION_CODE---
*/

saAmfResponse(amfHandle, invocation, SA_AIS_OK);
break;
}

case SA_AMF_HA_QUIESCED:
{
/*
* AMF has requested application to quiesce the CSI currently
* assigned the active or quiescing HA state. The application
* must stop work associated with the CSI immediately.
*/

/*
* ---BEGIN_APPLICATION_CODE---
*/
clprintf(CL_LOG_SEV_INFO, "csa101: Acknowledging new state\n");
running = 0;

/*
* ---END_APPLICATION_CODE---
*/

saAmfResponse(amfHandle, invocation, SA_AIS_OK);
break;
}

</pre></code>
|}
{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffccaa;" align="center"|clCompAppMain.c
|-
|<code><pre>
case SA_AMF_HA_QUIESCING:
{
/*
* AMF has requested application to quiesce the CSI currently
* assigned the active HA state. The application must stop work
* associated with the CSI gracefully and not accept any new
* workloads while the work is being terminated.
*/

/*
* ---BEGIN_APPLICATION_CODE---
*/
clprintf(CL_LOG_SEV_INFO, "csa101: Signaling completion of QUIESCING\n");
running = 0;

/*
* ---END_APPLICATION_CODE---
*/

saAmfCSIQuiescingComplete(amfHandle, invocation, SA_AIS_OK);
break;
}
</pre></code>
|}

We have modified the <code>clCompAppAMFCSISet</code> callback function to let our application know what to do when the state changes. In the case where the state changes to <code>SA_AMF_HA_ACTIVE</code> we set the <code>running</code> variable to 1. This will cause our application to begin printing the 'Hello World!' message. For any other state change we set the <code>running</code> variable to 0 which will cause the message to stop printing. For any state change we print out a message indicating the new state of the application.

<li>The last change that we make is to indicate to our application when the component is being disassociated with the workflow. (The following code begins at line 588 of the source file.)

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffccaa;" align="center"|clCompAppMain.c
|-
|<code><pre>
void clCompAppAMFCSIRemove(SaInvocationT invocation,
const SaNameT *compName,
const SaNameT *csiName,
SaAmfCSIFlagsT csiFlags)
{
....

/*
* Add application specific logic for removing the work for this CSI.
*/

/*
* ---BEGIN_APPLICATION_CODE---
*/
running = 0;

/*
* ---END_APPLICATION_CODE---
*/

saAmfResponse(amfHandle, invocation, SA_AIS_OK);

return;
}
</pre></code>
|}

In the <code>clCompAppAMFCSIRemove</code> callback function we indicate to our application that we are no longer running so that the while loop in the <code>hello_func</code> function stops printing our 'Hello World!' message.
</ol>

===Customizing the Component MakeFile===
We have to make a small change to the component <code>MakeFile</code> so that it knows about our special output library during the build. To do this we add the following lines. This file is located in <code>/home/clovis/projectarea1/ide_workspace/SampleModel/src/app</code>

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffccaa;" align="center"|Component MakeFile
|-
|<code><pre>
# ---BEGIN_APPLICATION_CODE---

SUBDIRS += ev

# ---END_APPLICATION_CODE---
</pre></code>
|}

===Customizing the Application MakeFile===
We have to make sure that our special output library is built along with our application. To do this we change the line listing the sudirectories to make as follows. This file is located in the directory <code>/home/clovis/projectarea1/ide_workspace/SampleModel/src/app/csa101</code>.

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffccaa;" align="center"|Application MakeFile
|-
|<code><pre>
# ---BEGIN_APPLICATION_CODE---

...

# Library added for demo console handling for the evaluation kit
ASP_LIBS += libeval.a

# ---END_APPLICATION_CODE---
</pre></code>
|}

We are finished customizing our application code!

==Building the csa101 Code==

Now that we have finished customizing the code it is time to build it. The build process is launched using the '''Project > Build Project''' menu item. Once selected the '''Build Configuration''' dialog appears.

[[File:Tutorial_BuildConfigDetails.png|frame|center| '''Build Configuration Details''' ]]

The '''Build Configuration''' dialog is used to gather specific information about the build we are about to perform. Using this dialog you can rebuild the same model using different cross builds, or including different chassis managers. We don't have to make any changes to this dialog since the default settings make sense for our sample application.

 [[File:OpenClovis_Note.png]]If you have prebuilt the SAFplus Platform libraries then you can check the '''Use pre built SAFplus''' checkbox and include the location of the prebuilt libraries. For more information about pre-building SAFplus Platform libraries, see ''OpenClovis SDK User Guide''.

 [[File:OpenClovis_Note.png]]The '''Include SNMP for North Bound Access''' control is checked by default. This just means that Net SNMP will be started along with our system. If you want end-to-end connectivity you will need to supply an SNMP Sub Agent and a MIB. See the ''OpenClovis SDK User Guide'' for more details.

 [[File:OpenClovis_Note.png]]In the '''Project''' menu if the '''Build Project''' entry is not highlighted, then click in the right pane i.e. '''Clovis Workspace''' pane and click the '''Project''' menu again. This not highlighting of the '''Build Project''' is because the '''Clovis Workspace''' is not selected properly because of moving focus to some other pane.

 Click the '''OK''' button to begin the build. If this is the first time that the project is being built, or if you have made changes to any setting on this screen, you will initially see a progress dialog indicating that the project is being configured. The configuration step is setting up the project for building. After the configuration has completed you will see a progress dialog indicating that the code is being built.

==Creating the csa101 Images==

Making the csa101 images will create software packages that can be deployed on target machines to run the example. The process of creating images is launched using the '''Project > Make Images''' menu item. Once selected the '''Make Images Configuration''' dialog appears.

[[File:Tutorial_MakeImagesConfigDetails.png|frame|center| '''Make Images Configuration Details''' ]]

The '''Make Images Configuration''' dialog is used to indicate information about the environment on which the images will be deployed. This information is used to tailor the images to run on that environment. Here we will make the following modificaiton.

<ul>
<li>Enter a value for the '''Trap IP'''. This value specifies where the SNMP sub-agent will send traps at runtime. This field is optional but if specified must be a valid IP address. Enter a value of '127.0.0.1' in this field.
<li>Enter a value for the '''TIPC Net ID'''. This value represents a unique identifier used by TIPC to set up interprocess communication across the deployed OpenClovis SAFplus Platform cluster. This field is required and should default to '1340'.
<li>Check the '''Create Node Specific Images''' and '''Package Images into Tarballs''' check boxes. This will create tarballs of the images making them easy to deploy to various machines.
<li>The table on this dialog will hold a row for each node instance defined in the model. In our case this is only one...SCNodeI0. For each of these instances we can define the slot number in the chassis on which the node will run and the network interface that the node will use for communication. In our case enter '1' for the Slot Number and 'eth0' for the Network Interface.
<li>Click '''OK''' to begin the make image process. A dialog box will appear and after a few seconds the the make images process will be complete.
</ul>

The images will be populated at <project_area>/target/SampleModel/images. Each node-specific image is provided as a directory containing the run-time files (binaries, libraries, prerequisites, and configuration files) as well as a tarball with the same content. e.g. For our model containing one node (<code>SCNodeI0</code>) the following files and directories are generated for deployment on the run-time system.
<code><pre>
<project_area>
|+target
|+<model>
|+images
|+SCNodeI0
| |+bin
| |+etc
| |+lib
| |+modules
| |+share
|-SCNodeI0.tgz
</pre></code>

The rest of the steps in this example are all done from the command line so we can exit the IDE. To do this use the '''File > Exit''' menu item.

==Deploying the csa101 Images==
Now that the image has been built we must deploy it so that we can run and observe our example. Since we are assuming that the example will be run on the same machine as the images were built this is a fairly trivial exercise. Use the following steps to deploy the runtime image.

<ol>
<li>First we create a directory where we will install the image. In our case we will use <code>/root/asp</code>.
<code><pre>
# cd /root
# mkdir asp
</pre></code>
<li>Next we navigate to that directory and untar the deployment package.
<code><pre>
# cd /root/asp
# tar xzvf /home/clovis/projectarea1/target/SampleModel/images/SCNodeI0.tgz
</pre></code>
</ol>

The System Controller is now installed and ready to run.

[[File:OpenClovis_Note.png]] If you were going to run the example on a machine other than the one where the images were built you would first copy the installation tarball to that machine before performing the above steps.

==Running the csa101 Example==
There are two parts to running the csa101 example. First we must start SAFplus Platform, and then we interact with the system components.

===Starting SAFplus Platform===

To start SAFplus Platform on System Controller node.
<ol>
<li>Open a shell.
<li>Run the following commands
<code><pre>
# cd /root/asp
# etc/init.d/asp start
</pre></code>
</ol>

[[File:OpenClovis_Note.png]] This assumes that you are running the SAFplus Platform example on the same PC that you are executing these commands. If you are running SAFplus Platform on a different machine then you should first ssh to that machine before executing the commands.

[[File:OpenClovis_Note.png]] If SAFplus Platform fails to start properly it could be due to the machine's firewall being enabled. SAFplus Platform will not run on a machine which has firewall enabled. See the ''Environment Related Observation'' section of the ''OpenClovis Release Notes'' for more information.

[[File:OpenClovis_Note.png]] By default the network interface used by the Group Membership Service is set to eth0. During the make images phase of the tutorial we also set the ethernet interface for node SCNodeI0 to be eth0. During image generation these configuration parameters are written to two files in the deployment package.
*<code>/root/asp/etc/clGmsConfig.xml</code>
*<code>/root/asp/etc/asp.conf</code>

There may be an occasion where you want to switch this interface for a machine on which you are deploying. If you would like to switch this interface on a machine without having to go through the process of rebuilding and redeploying, you can edit these two files and change the 'eth0' references to the interface you would like to use.

===Interacting with the System Components===
Once SAFplus Platform is up and running the next step is to start csa101 by informing SAFplus Platform that it should start the application. The Evaluation System's model tells SAFplus Platform that csa101 is locked for instantiation. This means that the process will not be started when SAFplus Platform comes up. This method of starting csa's is used for the Evaluation System, allowing users to interact with csa's and clearly see their output/functionality. Usually this would not be the case with applications, where they would run when SAFplus Platform begins.

At this point it would help to be familiar with the Service Availability Forum's notions of Service Unit, Service Group, and administrative state. The Service Availability Forum's Application Interface Specification (available from http://www.saforum.org/) is a good place to start.

In brief, the sample applications in the Evaluation System are part of service units which in turn are part of service groups. Service groups (and the service units that make up the service groups) can be in "administrative" states which include "LockInstantiation", "LockAssignment", and "Unlocked". There are other states, but these are the ones we care about for the purposes of this Evaluation System. If the administrative state of a service unit is "LockInstantiation" then the application that is part of that service unit will not even be started. If the administrative state is "LockAssignment" then the application will be started, but it will not be assigned any work. If the administrative state is "Unlocked" then it will not only be started, but will have a workload assigned to it, which is to say that it will start doing work (or start providing service), rather than idly sit waiting for work.

The administrative state of a service unit or service group can change from LockInstantiation to LockAssignment, from LockAssignment to Unlocked, or back to LockInstantiation, from Unlocked to LockAssignment. A picture might help here:

 [[File:eval_AdministrativeStateDiagram.png|frame|center| '''Partial Service Group Administrative State Diagram''' ]]

As the figure shows, the administrative state of a service unit (or service group) can change from "LockInstantiation" to "LockAssignment" and from there to "Unlocked", or back to "LockInstantiation". One way to change the administrative state of a service group is with the SAFplus Platform Console command line interface.

To use the SAFplus Platform Console:
<ol>
<li> Open a terminal on the Development Machine. (Or ssh into System Controller node as root, if you are running SAFplus Platform on a machine other than the development machine.)
<li> Change to image bin directory: <code><pre># cd /root/asp/bin</pre></code>

<li> Start the SAFplus Platform Console <code><pre># ./asp_console</pre></code>

<li> From within the SAFplus Platform Console: <code><pre>
cli[Test]-> setc 1
cli[Test:SCNodeI0]-> setc cpm
cli[Test:SCNodeI0:CPM]-> amsLockAssignment sg csa101SGI0
</pre></code>

The above changes the administrative state of the group csa101SGI0 from "locked-for-instantiation" to "locked-for-assignment".
 [[File:OpenClovis_Note.png]]For the command <code>cli[Test]-> setc 1</code>, the 1 represents the physical slot number of the System Controller within the Chassis. Remember that we set our System Controller to be in slot 1 in the make images dialog.

<li>Now lets tail the application log file so that we can see whats going on. In another window, as root, run:
<code><pre>
# tail -f /root/asp/var/log/csa101I0Log.latest
</pre></code>

You should see the following:

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffffaa;" align="center"| /root/asp/var/log/csa101I0Log.latest
|-
|<code><pre>
Tue Jul 15 21:32:06 2008 (SCNodeI0.10849 : csa101_EO.---.---.00034 : INFO)
Component [csa101I0] : PID [10849]. Initializing

Tue Jul 15 21:32:06 2008 (SCNodeI0.10849 : csa101_EO.---.---.00035 : INFO)
IOC Address : 0x1

Tue Jul 15 21:32:06 2008 (SCNodeI0.10849 : csa101_EO.---.---.00036 : INFO)
IOC Port : 0x80

Tue Jul 15 21:32:06 2008 (SCNodeI0.10849 : csa101_EO.---.---.00037 : INFO)
csa101: Instantiated as component instance csa101I0.

Tue Jul 15 21:32:06 2008 (SCNodeI0.10849 : csa101_EO.---.---.00038 : INFO)
csa101I0: Waiting for CSI assignment...
</pre></code>
|}

<li>Next change the administrative state of the csa101SGI0 service group to "unlocked" by running (in the SAFplus Platform Console) :
<code><pre>
# cli[Test:SCNodeI0:CPM]-> amsUnlock sg csa101SGI0
</pre></code>

In the window where you're running the "tail -f" you should see:

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffffaa;" align="center"| /root/asp/var/log/csa101I0Log.latest
|-
|<code><pre>
Tue Jul 15 21:36:17 2008 (SCNodeI0.10849 : csa101_EO.---.---.00049 : INFO)
csa101: ACTIVE state requested; activating service

Tue Jul 15 21:36:18 2008 (SCNodeI0.10849 : csa101_EO.---.---.00050 : INFO)
csa101: Hello World! .

Tue Jul 15 21:36:19 2008 (SCNodeI0.10849 : csa101_EO.---.---.00051 : INFO)
csa101: Hello World! .

Tue Jul 15 21:36:20 2008 (SCNodeI0.10849 : csa101_EO.---.---.00052 : INFO)
csa101: Hello World! .

Tue Jul 15 21:36:21 2008 (SCNodeI0.10849 : csa101_EO.---.---.00053 : INFO)
csa101: Hello World! .

Tue Jul 15 21:36:22 2008 (SCNodeI0.10849 : csa101_EO.---.---.00054 : INFO)
csa101: Hello World! .
</pre></code>
|}

As you can tell from the output log our component is up and running! It is continuously printing our 'Hello World!' output.

<li>Now change the state of the csa101SGI0 service group back to "locked-for-assignment" by running (in the SAFplus Platform Console):
<code><pre>
# cli[Test:SCNodeI0:CPM]-> amsLockAssignment sg csa101SGI0
</pre></code>

In the tail -f output you should see:

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffffaa;" align="center"| /root/asp/var/log/csa101I0Log.latest
|-
|<code><pre>
Tue Jul 15 21:39:29 2008 (SCNodeI0.10849 : csa101_EO.---.---.00241 : INFO)
csa101: Hello World! .

Tue Jul 15 21:39:30 2008 (SCNodeI0.10849 : csa101_EO.---.---.00242 : INFO)
Component [csa101I0] : PID [10849]. CSI Set Received

Tue Jul 15 21:39:30 2008 (SCNodeI0.10849 : csa101_EO.---.---.00243 : INFO)
CSI Flags : [Target One]

Tue Jul 15 21:39:30 2008 (SCNodeI0.10849 : csa101_EO.---.---.00244 : INFO)
CSI Name : [csa101CSII0]

Tue Jul 15 21:39:30 2008 (SCNodeI0.10849 : csa101_EO.---.---.00245 : INFO)
HA State : [Quiesced]

Tue Jul 15 21:39:30 2008 (SCNodeI0.10849 : csa101_EO.---.---.00246 : INFO)
csa101: Acknowledging new state

Tue Jul 15 21:39:30 2008 (SCNodeI0.10849 : csa101_EO.---.---.00249 : INFO)
Component [csa101I0] : PID [10849]. CSI Remove Received

Tue Jul 15 21:39:30 2008 (SCNodeI0.10849 : csa101_EO.---.---.00250 : INFO)
CSI : csa101CSII0

Tue Jul 15 21:39:30 2008 (SCNodeI0.10849 : csa101_EO.---.---.00251 : INFO)
CSI Flags : 0x2
</pre></code>
|}

Our component has been put into Lock Assignment state so our 'Hello World!' output has stopped printing to the log.

<li>At this point you can either unlock the service group to change its state to "unlocked" or you can lock it for instantiation to change it to state "locked-for-instantiation". The latter will cause the csa101 process to die. From state "locked-for-assignment", it is possible to change the state to "locked-for-instantiation" by running (in the SAFplus Platform Console):
<code><pre>
cli[Test:SCNodeI0:CPM]-> amsLockInstantiation sg csa101SGI0
cli[Test:SCNodeI0:CPM] -> end
cli[Test:SCNodeI0] -> end
cli[Test] -> bye
</pre></code>
</ol>

===Stopping SAFplus Platform===

To stop SAFplus Platform on the System Controller
<ol>
<li>Open a shell.
<li>ssh into the System Controller node as root.
<li>Once logged in, run the following command
<code><pre>
# cd /root/asp
# etc/init.d/asp stop
</pre></code>
</ol>

==Summary and Next Steps==
In the csa101 example we learned the following.

<ul>
<li>How to create a system model using the '''OpenClovis IDE'''.
<li>How to generate the source code.
<li>How to customize this source code to fit a specific application.
<li>How to configure and build the customized source code.
<li>How to make runtime images and deploy them to target machines.
<li>How to start and stop '''SAFplus'''.
<li>How to interact with system components using the '''SAFplus Platform Console'''.
</ul>

The next logical step would be to run through the '''OpenClovis Evaluation System User Guide'''. This guide goes over more complex system configurations and introduces new concepts.

For more in depth information on the '''OpenClovis IDE''' see the '''OpenClovis IDE User Guide'''.

For more in depth information on the '''OpenClovis SDK''' see the '''OpenClovis SDK User Guide'''.

==Appendix A: target.conf Settings==

Below is a description of the values in the settings in the <code>target.conf</code> file.

<ol>
<li>'''TRAP_IP''' (Mandatory): Specifies where the SNMP SubAgent should send traps at runtime. If you do not have an SNMP SubAgent in your model specify '''127.0.0.1''' as the value. e.g.:
<code><pre>
TRAP_IP=127.0.0.1
</pre></code>
<li>'''CMM_IP''' (Mandatory if deployed on an ATCA chassis): Specifies the IP address of the target system's chassis management module or shelf manager. ATCA chassis Example:
<code><pre>
CMM_IP=169.254.1.2
</pre></code>
<li>'''CMM_USERNAME''' and '''CMM_PASSWORD''' (Mandatory if deployed on an ATCA chassis): Specifies the username and password required for the OpenClovis SAFplus Platform Chassis Manager to connect to the target system's chassis management module. e.g.:
<code><pre>
CMM_USERNAME=root
CMM_PASSWORD=password
</pre></code>
<li>'''INSTALL_PREREQUISITES=YES|NO''' (Mandatory): Specifies whether the target images will include 3rd party runtime prerequisites or not. Say '''YES''' if the target nodes do not meet the target host requirements specified in the Installation section of this document. e.g.:
<code><pre>
INSTALL_PREREQUISITES=YES
</pre></code>
<li>'''INSTANTIATE_IMAGES=YES|NO''' (Mandatory): Specifies whether <code>make images</code> will generate node-instance specific images instead of only generating node-type specific images. This option is a development optimization for advanced users of OpenClovis SDK. If unsure, say '''YES'''. e.g.:
<code><pre>
INSTANTIATE_IMAGES=YES
</pre></code>
<li>'''CREATE_TARBALLS=YES|NO''' (Mandatory): Specifies whether the node-instance specific images created will be packaged into tarballs for deployment onto the target system. If unsure, say '''YES'''. e.g.:
<code><pre>
CREATE_TARBALLS=YES
</pre></code>
<li>'''TIPC_NETID''' (Mandatory): Specifies a unique identifier used by TIPC to set up interprocess communication across the deployed OpenClovis SAFplus Platform cluster. This is an unsigned 32-bit integer, and must be unique for every model that is deployed. e.g.:
<code><pre>
TIPC_NETID=1337
</pre></code>
<li>'''Node Instance Details''': These specify the node-instance specific parameters required for deploying the model. For each node in the model there is a corresponding entry in the file:
<ol>
<li>'''SLOT_<node instance name>''' (Mandatory): Specifies which slot the node is located in. The first slot is slot 1 -- DO NOT USE SLOT NUMBER 0, it is invalid. When deployed to an ATCA chassis, the physical slot in which the blade is actually installed will override this value. When deployed to regular (non-ATCA) systems, this is a logical slot and must be unique for every node in the cluster. e.g.:
<code><pre>
SLOT_SCNodeI0=1
</pre></code>
<li>'''LINK_<node instance name>''' (Optional): Specifies the ethernet interface used by the node for OpenClovis SAFplus Platform communication with the rest of the cluster. If unspecified, this defaults to <code>eth0</code>. e.g.:
<code><pre>
LINK_SCNodeI0=eth0
</pre></code>
<li>'''ARCH_<node instance name>''' (Optional if '''ARCH''' is specified): Specifies the target architecture of the node as a combination of machine architecture (MACH) and linux kernel version. This is only required on a per-node basis if the target cluster has heterogeneous architectures across the nodes. If it is a homogeneous cluster, a single '''ARCH''' parameter (described below) will suffice. e.g.:
<code><pre>
ARCH_SCNodeI0=i386/linux-2.6.14
</pre></code>
<li>'''ARCH''' (Optional if node-specific '''ARCH_''' parameters are specified): Specifies the target architecture of all nodes in a homogeneous cluster as a combination of machine architecture (MACH) and linux kernel version. Note: The build process automatically populates this variable based on the last target the model is built for.e.g.:
<code><pre>
ARCH=i386/linux-2.6.14
</pre></code>
</ol>
For example, if we have a three-node cluster with the following details:
{| border="0" cellpadding="3" align="center" width="600"
|+ align="bottom" | '''Example Node Instance Detail'''
|- style="color:#ffffff; background:#549cc6"
!style="color:#66b154; background:#09477c"| Node Name
!style="color:#66b154; background:#09477c"| Slot Number
!style="color:#66b154; background:#09477c"| Link Interface
!style="color:#66b154; background:#09477c"| Architecture
|- style="color:#ffffff; background:#549cc6"
|SCNodeI0
|1
|eth0
|i386/linux-2.6.14
|- style="color:#ffffff; background:#549cc6"
|PayloadNodeI0
|3
|eth0
|i386/linux-2.6.14
|- style="color:#ffffff; background:#549cc6"
|PayloadNodeI1
|4
|eth1
|ppc/linux-2.6.9
|}
we would specify the node instance details as:
<code><pre>
SLOT_SCNodeI0=1
SLOT_PayloadNodeI0=3
SLOT_PayloadNodeI1=4

LINK_SCNodeI0=eth0
LINK_PayloadNodeI0=eth0
LINK_PayloadNodeI1=eth1

ARCH_SCNodeI0=i386/linux-2.6.14
ARCH_PayloadNodeI0=i386/linux-2.6.14
ARCH_PayloadNodeI1=ppc/linux-2.6.9
</pre></code>
</ol>

==Appendix B: AMF Configuration Details==
This appendix gives brief descriptions of configuration details for instances of different entities (like Node, Service Group, Service Unit etc) that are present in the '''Clovis''' -> '''AMF Configuration''' dialog box.

===Node Instance===
This screen displays the node instance that was created by the Node Instance Wizard. This node instance was created because the node type '''SCNode''' was selected on the wizard screen.

[[File:Tutorial_NodeInstanceDetails.png|frame|center| '''Node Instance Details''' ]]

The information on this screen is described below.
<ul>
<li>'''Node Instance Name''': This field holds the name of the node instance. This name must be unique. The name that was generated combines the node type (SCNode), the letter I (for Instance), and the number 0 (since this is the first instance of this type).
<li>'''Node Type''': This field holds the node type that was selected on the wizard screen.
<li>'''MOID''': This is the unique identifier for the node instance. It was generated by the wizard. The format of this ID is a string representing the one and only instance of the chassis (\Chassis:0) defined in the Resource Editor followed by a string representing the first and only instance of the blade type (\SysBlade:0) that was selected in the Node Instance Wizard.
 [[File:OpenClovis_Note.png]]'''MOID''' is an acronym for Managed Object Identifier. It must be unique and is used to identify which hardware chassis and blade type this instance will run on.
</ul>

===Service Unit Instance===
This screen displays the service unit instance that was created by the Service Group Instance Wizard. This service unit instance was created because the service unit type is associated with both the selected node type (SCNode) and the selected service group type (csa101SG) in our model.

[[File:Tutorial_SUInstanceDetails.png|frame|center| '''SU Instance Details''' ]]

The information on this screen is described below.
<ul>
<li>'''SU Instance Name''': This field holds the name of the service unit instance. This name must be unique. The name that was generated combines the service unit type (csa101SU), the letter I (for Instance), and the number 0 (since this is the first instance of this type).
<li>'''Service Unit Type''': This field holds the type of the service unit instance.
</ul>

===Component Instance===
This screen displays the component instance that was created by the Service Group Instance Wizard. This component instance was created because the component type is associated with the created parent service unit type (csa101SU) in our model.

[[File:Tutorial_ComponentInstanceDetails.png|frame|center| '''Component Instance Details''' ]]

The information on this screen is described below.
<ul>
<li>'''Component Instance Name''': This field holds the name of the component instance. This name must be unique. The name that was generated combines the component type (csa101), the letter I (for Instance), and the number 0 (since this is the first instance of this type).
<li>'''Component Type''': This field holds the type of the component instance.
</ul>

===Service Group Instance===
This screen displays the service group instance that was created by the Service Group Instance Wizard. This service group instance was created because the service group type '''csa101SG''' was selected on the wizard screen.

[[File:Tutorial_SGInstanceDetails.png|frame|center| '''Service Group Instance Details''' ]]

The information on this screen is described below.
<ul>
<li>'''SG Instance Name''': This field holds the name of the service group instance. This name must be unique. The name that was generated combines the service group type (csa101SG), the letter I (for Instance), and the number 0 (since this is the first instance of this type).
<li>'''ServiceGroup Type''': This field holds the type of the service group instance.
<li>'''Associated Service Units''': This button is used to associate service unit instances with this service group instance. Creating this association indicates that the selected service unit(s) will run within this service group instance.
</ul>

Clicking the '''Associated Service Units''' Edit... button will display the following dialog.

[[File:Tutorial_SG_SI_Association.png|frame|center| '''Associated Service Units Dialog''' ]]

This dialog lists the service unit instances that can be associated with this service group instance. The list contains only one item, the service unit instance that was created by the wizard. This item is checked indicating that the wizard automatically chose this service unit instance to run within the service group instance.

===Service Instance Instance===
This screen displays the service instance that was created by the Service Group Instance Wizard. This service instance was created because the service instance type is associated with the parent service group type (csa101SG) in our model.

[[File:Tutorial_SIInstanceDetails.png|frame|center| '''Service Instance Details''' ]]

The information on this screen is described below.
<ul>
<li>'''Service Instance Name''': This field holds the name of the service instance. This name must be unique. The name that was generated combines the service instance type (csa101SI), the letter I (for Instance), and the number 0 (since this is the first instance of this type).
<li>'''ServiceInstance Type''': This field holds the type of the service instance.
</ul>

===Component Service Instance Instance===
This screen displays the component service instance that was created by the Service Group Instance Wizard. This component service instance was created because the component service instance is associated with the parent service instance type (csa101SI) in our model.

[[File:Tutorial_CSIInstanceDetails.png|frame|center| '''Component Service Instance Details''' ]]

The information on this screen is described below.
<ul>
<li>'''Component Service Instance Name''': This field holds the name of the component service instance. This name must be unique. The name that was generated combines the component service instance type (csa101CSI), the letter I (for Instance), and the number 0 (since this is the first instance of this type).
<li>'''ComponentServiceInstance Type''': This field holds the type of the component service instance.
</ul>

OpenClovis Product Documentation - User contributions [en]

Doc:latest/tutorial