OpenClovis Product Documentation - User contributions [en]

ClLogFilterSet

2013-04-16T19:24:04Z

Karthick:

Here's how you can override the default log filters for the various log streams.
For the openclovis nodename log files in var/log/<NODENAME>.log, you can use the env

export CL_LOG_SEVERITY=DEBUG

to override the default severity of NOTICE.

For pre-created openclovis sys or app log streams, you can use the env:

export CL_LOG_STREAM_SEVERITY=NOTICE

to override the default severity of DEBUG.

For dynamically created runtime log streams, there is another env. to make your life easier that overrides the default DEBUG severity.

export CL_LOG_STREAM_SEVERITY_CUSTOM=TRACE

and runtime log streams would start getting trace instead of debug.

This can be achieved without writing any code to modify the severity of runtime created stream/s.

All of the above can be configured pretty easily by modifications to asp.conf.

However, if you still want to modify runtime stream filter level using code/api given the clLogStreamOpen returned stream handle after open, you can use the below code snippet that uses clLogFilterSet to modify the log severity.

ClRcT setLogStreamSeverity(const ClNameT *pStreamName,
ClLogStreamHandleT stream,
ClUint32T sev)
{
ClRcT rc = CL_OK;
ClLogFilterT filter = {0};
filter.severityFilter = ( 1 << sev) -1;
clLogDebug("FILTER", "SET", "Setting log severity for stream [%.*s] to [%s]",
pStreamName->length, pStreamName->value, clLogSeverityStrGet(sev));
rc = clLogFilterSet(stream, CL_LOG_FILTER_ASSIGN, filter);
if(rc != CL_OK)
{
clLogError("FILTER", "SET", "Setting log filter for app stream returned with [%#x]",
rc);
}
return rc;
}

For eg:, to change the severity of a runtime example_stream to TRACE, you can use it as below:

ClNameT streamName;

clNameSet(&streamName, "example_stream");

setLogStreamSeverity(&streamName, streamOpenHandle, CL_LOG_SEV_TRACE);

ClLogFilterSet

2013-04-16T19:22:26Z

Karthick:

Here's how you can override the default log filters for the various log streams.
For the openclovis nodename log files in var/log/<NODENAME>.log, you can use the env

export CL_LOG_SEVERITY=DEBUG

to override the default severity of NOTICE.

For pre-created openclovis sys or app log streams, you can use the env:

export CL_LOG_STREAM_SEVERITY=NOTICE

to override the default severity of DEBUG.

For dynamically created runtime log streams, there is another env. to make your life easier that overrides the default DEBUG severity.

export CL_LOG_STREAM_SEVERITY_CUSTOM=TRACE

and runtime log streams would start getting trace instead of debug.

This can be achieved without writing any code to modify the severity of runtime created stream/s.

All of the above can be configured pretty easily by modifications to asp.conf.

However, if you still want to modify runtime stream filter level using code/api given the clLogStreamOpen returned stream handle after open, you can use the below code snippet that uses clLogFilterSet to modify the log severity.

ClRcT setLogStreamSeverity(const ClNameT *pStreamName, ClLogStreamHandleT stream, ClUint32T sev)
{
ClRcT rc = CL_OK;
ClLogFilterT filter = {0};
filter.severityFilter = ( 1 << sev) -1;
clLogDebug("FILTER", "SET", "Setting log severity for stream [%.*s] to [%s]",
pStreamName->length, pStreamName->value, clLogSeverityStrGet(sev));
rc = clLogFilterSet(stream, CL_LOG_FILTER_ASSIGN, filter);
if(rc != CL_OK)
{
clLogError("FILTER", "SET", "Setting log filter for app stream returned with [%#x]",
rc);
}
return rc;
}

For eg:, to change the severity of a runtime example_stream to TRACE, you can use it as below:

ClNameT streamName;

clNameSet(&streamName, "example_stream");

setLogStreamSeverity(&streamName, streamOpenHandle, CL_LOG_SEV_TRACE);

ClLogFilterSet

2013-04-16T19:22:05Z

Karthick:

Here's how you can override the default log filters for the various log streams.
For the openclovis nodename log files in var/log/<NODENAME>.log, you can use the env

export CL_LOG_SEVERITY=DEBUG

to override the default severity of NOTICE.

For pre-created openclovis sys or app log streams, you can use the env:

export CL_LOG_STREAM_SEVERITY=NOTICE

to override the default severity of DEBUG.

For dynamically created runtime log streams, there is another env. to make your life easier that overrides the default DEBUG severity.

export CL_LOG_STREAM_SEVERITY_CUSTOM=TRACE

and runtime log streams would start getting trace instead of debug.

This can be achieved without writing any code to modify the severity of runtime created stream/s.

All of the above can be configured pretty easily by modifications to asp.conf.

However, if you still want to modify runtime stream filter level using code/api given the clLogStreamOpen returned stream handle after open, you can use the below code snippet that uses clLogFilterSet to modify the log severity.

ClRcT setLogStreamSeverity(const ClNameT *pStreamName, ClLogStreamHandleT stream, ClUint32T sev)
{
ClRcT rc = CL_OK;
ClLogFilterT filter = {0};
filter.severityFilter = ( 1 << sev) -1;
clLogDebug("FILTER", "SET", "Setting log severity for stream [%.*s] to [%s]",
pStreamName->length, pStreamName->value, clLogSeverityStrGet(sev));
rc = clLogFilterSet(stream, CL_LOG_FILTER_ASSIGN, filter);
if(rc != CL_OK)
{
clLogError("FILTER", "SET", "Setting log filter for app stream returned with [%#x]",
rc);
}
return rc;
}

For eg:, to change the severity of a runtime example_stream to TRACE, you can use it as below:

ClNameT streamName;

clNameSet(&streamName, "example_stream");

setLogStreamSeverity(&streamName, streamOpenHandle, CL_LOG_SEV_TRACE);

ClLogFilterSet

2013-04-16T19:21:34Z

Karthick:

Here's how you can override the default log filters for the various log streams.
For the openclovis nodename log files in var/log/<NODENAME>.log, you can use the env

export CL_LOG_SEVERITY=DEBUG

to override the default severity of NOTICE.

For pre-created openclovis sys or app log streams, you can use the env:
export CL_LOG_STREAM_SEVERITY=NOTICE to override the default severity of DEBUG.

For dynamically created runtime log streams, there is another env. to make your life easier that overrides the default DEBUG severity.

export CL_LOG_STREAM_SEVERITY_CUSTOM=TRACE

and runtime log streams would start getting trace instead of debug.

This can be achieved without writing any code to modify the severity of runtime created stream/s.

All of the above can be configured pretty easily by modifications to asp.conf.

However, if you still want to modify runtime stream filter level using code/api given the clLogStreamOpen returned stream handle after open, you can use the below code snippet that uses clLogFilterSet to modify the log severity.

ClRcT setLogStreamSeverity(const ClNameT *pStreamName, ClLogStreamHandleT stream, ClUint32T sev)
{
ClRcT rc = CL_OK;
ClLogFilterT filter = {0};
filter.severityFilter = ( 1 << sev) -1;
clLogDebug("FILTER", "SET", "Setting log severity for stream [%.*s] to [%s]",
pStreamName->length, pStreamName->value, clLogSeverityStrGet(sev));
rc = clLogFilterSet(stream, CL_LOG_FILTER_ASSIGN, filter);
if(rc != CL_OK)
{
clLogError("FILTER", "SET", "Setting log filter for app stream returned with [%#x]",
rc);
}
return rc;
}

For eg:, to change the severity of a runtime example_stream to TRACE, you can use it as below:

ClNameT streamName;

clNameSet(&streamName, "example_stream");

setLogStreamSeverity(&streamName, streamOpenHandle, CL_LOG_SEV_TRACE);

ClLogFilterSet

2013-04-16T19:19:40Z

Karthick: Created page with "Here's how you can override the default log filters for the various log streams. For the openclovis nodename log files in var/log/<NODENAME>.log, you can use the env. -- expor..."

Here's how you can override the default log filters for the various log streams.
For the openclovis nodename log files in var/log/<NODENAME>.log, you can use the env. --
export CL_LOG_SEVERITY=DEBUG
to override the default severity of NOTICE.

For pre-created openclovis sys or app log streams, you can use the env:
export CL_LOG_STREAM_SEVERITY=NOTICE to override the default severity of DEBUG.

For dynamically created runtime log streams, there is another env. to make your life easier that overrides the default DEBUG severity.

export CL_LOG_STREAM_SEVERITY_CUSTOM=TRACE
and runtime log streams would start getting trace instead of debug.

This can be achieved without writing any code to modify the severity of runtime created stream/s.

All of the above can be configured pretty easily by modifications to asp.conf.

However, if you still want to modify runtime stream filter level using code/api given the clLogStreamOpen returned stream handle after open, you can use the below code snippet that uses clLogFilterSet to modify the log severity.

ClRcT setLogStreamSeverity(const ClNameT *pStreamName, ClLogStreamHandleT stream, ClUint32T sev)
{
ClRcT rc = CL_OK;
ClLogFilterT filter = {0};
filter.severityFilter = ( 1 << sev) -1;
clLogDebug("FILTER", "SET", "Setting log severity for stream [%.*s] to [%s]",
pStreamName->length, pStreamName->value, clLogSeverityStrGet(sev));
rc = clLogFilterSet(stream, CL_LOG_FILTER_ASSIGN, filter);
if(rc != CL_OK)
{
clLogError("FILTER", "SET", "Setting log filter for app stream returned with [%#x]",
rc);
}
return rc;
}

For eg:, to change the severity of a runtime example_stream to TRACE, you can use it as below:
ClNameT streamName = {0};
clNameSet(&streamName, "example_stream");
setLogStreamSeverity(&streamName, streamOpenHandle, CL_LOG_SEV_TRACE);

Doc:latest/evalguide/dhaDemo

2012-11-16T21:46:44Z

Karthick: /* Code */

==Dynamic HA Evaluation Guide==

===Objective===

This sample application demonstrates dynamic HA (High Availability) functionality. The application has two components : dhaDemo and dummyComp
*dhaDemo creates/deletes the AMF entities (SG, SI, CSI, SU, Component, etc) dynamically.
*dummyComp is a sample SAF component whose binary(executable) will be used while launching the dynamically created component.

===What you will learn===

*How to create a 2N model dynamically by creating/deleting various AMF entities using Clovis AMF management APIs related to Dynamic HA.

===Building the dynamic HA model (dynamicHaDemo) and deploying runtime images===

The Clovis dynamic HA Application is located in : <install_dir>/sdk-5.0/src/examples/dynamicHaDemo

You need to build the model and deploy the runtime images for following nodes : SysCtrlI0, WorkerI0, WorkerI1

It can be done in very similar manner to evaluation system model (eval). For more information about building and deploying a model, please refer to the following section of evalguide: 
Building the Evaluation System and Deploying Runtime Images

===Code===

The application code can be found within the following directory
<project-area_dir>/dynamicHaDemo/src/app/dhaDemo

This sample component is implemented in a single C module (clCompAppMain.c).
It uses the AMF dynamic HA apis to create a 2N SG on the fly using the clAmsMgmtCCB apis.

There is an alternate version of this C file: clCompAppMain_batch.c which uses a faster version of these apis using clAmsMgmtCCBBatch apis.

The batch version of the dynamic HA apis are faster as the AMF entity CRUD operatons are batched/cached on the client side before they are
committed with clAmsMgmtCCBBatchCommit api.

Both the clAmsMgmtCCB and clAmsMgmtCCBBatch version of the APIs are declared in clAmsMgmtClientApi.h which needs to be included for usage.

====Start/Stop the application====

The <code>clCompAppAMFCSISet()</code> function is called to set the component's HA state, and the following block of code assigns this requested state to the component, while verbosely detailing this process:

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

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_NOTICE, "Starting dynamic HA demo.");
clprintf(CL_LOG_SEV_NOTICE, "It will create 2N SG : %sSG", BASE_NAME);
rc = clDhaDemoStart();
if(rc != CL_OK)
{
clprintf(CL_LOG_SEV_CRITICAL, "Failed to start dynamic HA demo.");
}

/*
* ---End_APPLICATION_CODE---
*/

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

</pre></code>
|}

* clDhaDemoStart() will start the workload in a separate thread to create the AMF entities (SG, SI, CSI, SU, Components, etc) when the HA state of dhaDemo becomes ACTIVE. In this case dhaDemo will be assigned active state when you unlock the SG 'dhaDemoSG'

{| 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_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---
*/

rc = clDhaDemoStop();
if(rc != CL_OK)
{
clprintf(CL_LOG_SEV_CRITICAL, "Failed to stop dynamic HA demo.");
}

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

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

</pre></code>
|}

* clDhaDemoStop() will start the workload in a separate thread to delete the AMF entities (SG, SI, CSI, SU, Components, etc) only if they are already created, when the HA state of dhaDemo becomes QUIESCED or QUIESCING. In this case dhaDemo will be get QUIESCED state when you lock the unlocked SG 'dhaDemoSG'

====Create/Delete the AMF entities====

* clDhaDemoCreate() contains the code to create various AMF entities dynamically.

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

rc = clAmsMgmtInitialize(&mgmtHandle, NULL, &version);
if(rc != CL_OK)
{
clprintf(CL_LOG_SEV_ERROR, "AmsMgmt initialize returned [%#x]", rc);
return NULL;
}

clDhaExmpExec(("Running MGMT CCB initialize"),
(rc = clAmsMgmtCCBInitialize(mgmtHandle, &ccbHandle)) == CL_OK,
("MGMT CCB initialize returned [%#x]", rc),
goto out1);

/*
* Create the entities only if they are not created already
*/
entity.type = CL_AMS_ENTITY_TYPE_SG;
snprintf(entity.name.value, sizeof(entity.name.value), "%sSG", pBaseName);
entity.name.length = strlen(entity.name.value)+1;

rc = clAmsMgmtEntityGetConfig(mgmtHandle,
&entity,
&pEntityConfig);

clHeapFree(pEntityConfig);

if(rc == CL_OK)
{
clprintf(CL_LOG_SEV_INFO, "Not creating SG[%sSG], it already exist", pBaseName);
goto out2;
}

/* SG doesn't exist, create SG and other entities dynamically*/

/*First create the service hierarchies*/

clprintf(CL_LOG_SEV_NOTICE,
"Creating 2N SG [%sSG] and other entities(si, csi, su, comp, etc)",
pBaseName);

/* Create SG*/
entity.type = CL_AMS_ENTITY_TYPE_SG;
snprintf(entity.name.value, sizeof(entity.name.value),
"%sSG", pBaseName);
entity.name.length = strlen(entity.name.value)+1;

clDhaExmpExec(("Creating SG [%s]",
entity.name.value),
(rc = clAmsMgmtCCBEntityCreate(ccbHandle,
&entity)) == CL_OK,
("SG create returned [%#x]", rc),
goto out2);

/* Create SI*/
entity.type = CL_AMS_ENTITY_TYPE_SI;
snprintf(entity.name.value, sizeof(entity.name.value),
"%sSI", pBaseName);
entity.name.length = strlen(entity.name.value)+1;
clDhaExmpExec( ("Create SI [%s]", entity.name.value),
(rc = clAmsMgmtCCBEntityCreate(ccbHandle, &entity)) == CL_OK,
("SI create returned [%#x]", rc),
goto out2);

...
...
...

/* CCB Commit*/
clDhaExmpExec(("CCB Commit Create"),
(rc = clAmsMgmtCCBCommit(ccbHandle)) == CL_OK,
("CCB commit returned [%#x]", rc),
goto out2);

...
...

</pre></code>
|}

* clDhaDemoDelete() contains the code to delete the created AMF entities dynamically.

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

rc = clAmsMgmtInitialize(&mgmtHandle, NULL, &version);
if(rc != CL_OK)
{
clprintf(CL_LOG_SEV_ERROR, "AmsMgmt initialize returned [%#x]", rc);
return NULL;
}

clDhaExmpExec(("Running MGMT CCB initialize"),
(rc = clAmsMgmtCCBInitialize(mgmtHandle, &ccbHandle)) == CL_OK,
("MGMT CCB initialize returned [%#x]", rc),
goto out1);

/*
* Delete the entities only if they exist
*/
entity.type = CL_AMS_ENTITY_TYPE_SG;
snprintf(entity.name.value, sizeof(entity.name.value), "%sSG", pBaseName);
entity.name.length = strlen(entity.name.value)+1;

rc = clAmsMgmtEntityGetConfig(mgmtHandle,
&entity,
&pEntityConfig);
clHeapFree(pEntityConfig);
if(rc != CL_OK)
{
clprintf(CL_LOG_SEV_INFO, "Not deleting SG[%sSG], SG config get returned [%#x]", pBaseName, rc);
goto out2;

}

/* SG exist, Delete SG and other entities dynamically*/

clprintf(CL_LOG_SEV_NOTICE,
"Deleting SG [%sSG] and other entities(si, csi, su, comp, etc)",
pBaseName);

/*First move entities to lock instantiated mode*/
clDhaExmpExec(("LockI AMS entities"),
(rc = clAmsMgmtTestLockI(mgmtHandle, ccbHandle, pBaseName)) == CL_OK,
("Unlock AMS entities returned [%#x]", rc),
goto out2);

...
...

/* Delete SI*/
entity.type = CL_AMS_ENTITY_TYPE_SI;
snprintf(entity.name.value, sizeof(entity.name.value),
"%sSI", pBaseName);
entity.name.length = strlen(entity.name.value)+1;
clDhaExmpExec( ("Delete SI [%s]", entity.name.value),
(rc = clAmsMgmtCCBEntityDelete(ccbHandle, &entity)) == CL_OK,
("SI delete returned [%#x]", rc),
goto out2);

/* Delete SG*/
entity.type = CL_AMS_ENTITY_TYPE_SG;
snprintf(entity.name.value, sizeof(entity.name.value),
"%sSG", pBaseName);
entity.name.length = strlen(entity.name.value)+1;
clDhaExmpExec(("Deleting SG [%s]",
entity.name.value),
(rc = clAmsMgmtCCBEntityDelete(ccbHandle,
&entity)) == CL_OK,
("SG delete returned [%#x]", rc),
goto out2);

/* CCB Commit*/
clDhaExmpExec(("CCB Commit Delete"),
(rc = clAmsMgmtCCBCommit(ccbHandle)) == CL_OK,
("CCB commit returned [%#x]", rc),
goto out2);

...
...

</pre></code>
|}

====Usage of AMF management APIs for Dynamic HA====

The detailed documentation of AMF management APIs can be found in "OpenClovis API Reference Guide". Please refer "Availability Management Service" section under the High Availability.

===How to Run dhaDemo application and What to Observe===

We will use the SAFplus Platform Console to manipulate the administrative state of the dhaDemoSG service group.

<ol>

<li>Start the SAFplus Platform on all deployed nodes<code><pre>
# cd /root/asp/
# ./etc/init.d/asp start</pre></code>

<li>Start the SAFplus Platform Console<code><pre>
# cd /root/asp/bin
# ./asp_console</pre></code>

<li>Then put the dhaDemoSG service group into lock assignment state using the following commands.<code><pre>
# cli[Test]-> setc master
# cli[Test:SysCtrlI0]-> setc cpm
# cli[Test:SysCtrlI0:CPM]-> amsLockAssignment sg dhaDemoSG
</pre></code>

The logs for dhaDemo application will be logged into file <code>/root/asp/var/log/app.0</code> on node WorkerI0. Viewing these application logs using the <code>tail -f</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/app.0
|-
|<code><pre>

Wed Sep 3 16:03:02 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00031 : INFO) Component [dhaDemo] : PID [21785]. Initializing

Wed Sep 3 16:03:02 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00032 : INFO) IOC Address : 0x3

Wed Sep 3 16:03:02 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00033 : INFO) IOC Port : 0x80

</pre></code>
|}

<li>To create the AMF entities dynamically, unlock the dhaDemoSG service group using the following SAFplus Platform Console command.
<code><pre>
# cli[Test:SysCtrlI0:CPM]-> amsUnlock sg dhaDemoSG
</pre></code>
and in the <code>/root/asp/var/log/app.0</code> file (on node WorkerI0) , we should see:

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffffaa;" align="center"| /root/asp/var/log/app.0
|-
|<code><pre>

Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00036 : INFO) Component [dhaDemo] : PID [21785]. CSI Set Received

Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00037 : INFO) CSI Flags : [Add One]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00038 : INFO) CSI Name : [dhaDemoCSI]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00039 : INFO) Name value pairs :
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00040 : INFO) HA state : [Active]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00041 : INFO) Active Descriptor :
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00042 : INFO) Transition Descriptor : [1]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00043 : INFO) Active Component : [dhaDemo]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00044 : NOTICE) Starting dynamic HA demo.
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00045 : NOTICE) It will create 2N SG : dynamicTwoNSG
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00046 : INFO) Running MGMT initialize
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00047 : INFO) Running MGMT CCB initialize
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00048 : NOTICE) Creating 2N SG [dynamicTwoNSG] and other entities(si, csi, su, comp, etc)
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00049 : INFO) Creating SG [dynamicTwoNSG]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00050 : INFO) Create SI [dynamicTwoNSI]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00051 : INFO) Create CSI [dynamicTwoNCSI]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00052 : INFO) Create SU [dynamicTwoNSU0]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00053 : INFO) Create SU [dynamicTwoNSU1]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00054 : INFO) Create COMP [dynamicComp0]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00055 : INFO) Create COMP [dynamicComp1]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00056 : INFO) CCB Commit Create
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00057 : INFO) Fill SG config
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00058 : INFO) SG config get [dynamicTwoNSG]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00059 : INFO) SG set SI [dynamicTwoNSI]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00060 : INFO) SG set SU [dynamicTwoNSU0]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00061 : INFO) SG set SU [dynamicTwoNSU1]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00062 : INFO) SG set commit
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00063 : INFO) Fill SI config
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00064 : INFO) SI config get [dynamicTwoNSI]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00065 : INFO) SI config set [dynamicTwoNSI]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00066 : INFO) SI set CSI [dynamicTwoNCSI]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00067 : INFO) SI set commit
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00068 : INFO) Fill CSI config
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00069 : INFO) CSI config get [dynamicTwoNCSI]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00070 : INFO) CSI type set [dynamicTwoNCSIType]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00071 : INFO) CSI set nvplist
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00072 : INFO) CSI ccb commit
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00073 : INFO) Fill SU config
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00074 : INFO) SU config get [dynamicTwoNSU0]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00075 : INFO) SU config set [dynamicTwoNSU0]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00076 : INFO) SU config set [dynamicTwoNSU1]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00077 : INFO) SU [dynamicTwoNSU0] add comp [dynamicComp0]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00078 : INFO) SU [dynamicTwoNSU1] add comp [dynamicComp1]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00079 : INFO) SU set commit
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00080 : INFO) Fill NODE config
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00081 : INFO) NODE config get [WorkerI1]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00082 : INFO) Node set SU [dynamicTwoNSU1]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00083 : INFO) NODE config get [WorkerI0]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00084 : INFO) Node set SU [dynamicTwoNSU0]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00085 : INFO) Node set commit
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00086 : INFO) Fill COMP config
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00087 : INFO) COMP config get [dynamicComp0]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00088 : INFO) Comp config set [dynamicComp0]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00089 : INFO) Comp config set [dynamicComp1]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00090 : INFO) Comp set commit
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00091 : INFO) Unlock AMS entities
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00092 : INFO) LockA [dynamicTwoNSU0]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00093 : INFO) Unlock [dynamicTwoNSU0]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00094 : INFO) LockA [dynamicTwoNSU1]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00095 : INFO) Unlock [dynamicTwoNSU1]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00096 : INFO) Unlock SI [dynamicTwoNSI]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00097 : INFO) LockA SG [dynamicTwoNSG]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00098 : INFO) Unlock SG [dynamicTwoNSG]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00099 : INFO) Running CCB finalize
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00100 : INFO) Running MGMT finalize
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00101 : NOTICE) Successfully created 2N SG [dynamicTwoNSG] and its entities(si, csi, su, comp, etc) dynamically

</pre></code>
|}

*The dynamically created components 'dynamicComp0' and 'dynamicComp1' will come up as active/standby. Which can be verified through the logs present at nodes WorkerI0 and WorkerI1.

<code>/root/asp/var/log/app.0</code> file (on node WorkerI0) , we should see the dynamically created component getting assigned ACTIVE state:

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffffaa;" align="center"| /root/asp/var/log/app.0
|-
|<code><pre>

Wed Sep 3 16:07:43 2008 (WorkerI0.22187 : dummyComp_EO.---.---.00031 : INFO) Component [dynamicComp0] : PID [22187]. Initializing

Wed Sep 3 16:07:43 2008 (WorkerI0.22187 : dummyComp_EO.---.---.00032 : INFO) IOC Address : 0x3

Wed Sep 3 16:07:43 2008 (WorkerI0.22187 : dummyComp_EO.---.---.00033 : INFO) IOC Port : 0x81

Wed Sep 3 16:07:43 2008 (WorkerI0.22187 : dummyComp_EO.---.---.00036 : INFO) Component [dynamicComp0] : PID [22187]. CSI Set Received

Wed Sep 3 16:07:43 2008 (WorkerI0.22187 : dummyComp_EO.---.---.00037 : INFO) CSI Flags : [Add One]
Wed Sep 3 16:07:43 2008 (WorkerI0.22187 : dummyComp_EO.---.---.00038 : INFO) CSI Name : [dynamicTwoNCSI]
Wed Sep 3 16:07:43 2008 (WorkerI0.22187 : dummyComp_EO.---.---.00039 : INFO) Name value pairs :
Wed Sep 3 16:07:43 2008 (WorkerI0.22187 : dummyComp_EO.---.---.00040 : INFO) Name : [model]
Wed Sep 3 16:07:43 2008 (WorkerI0.22187 : dummyComp_EO.---.---.00041 : INFO) Value : [twoN]
Wed Sep 3 16:07:43 2008 (WorkerI0.22187 : dummyComp_EO.---.---.00042 : INFO) HA state : [Active]
Wed Sep 3 16:07:43 2008 (WorkerI0.22187 : dummyComp_EO.---.---.00043 : INFO) Active Descriptor :
Wed Sep 3 16:07:43 2008 (WorkerI0.22187 : dummyComp_EO.---.---.00044 : INFO) Transition Descriptor : [1]
Wed Sep 3 16:07:43 2008 (WorkerI0.22187 : dummyComp_EO.---.---.00045 : INFO) Active Component : [dynamicComp0]

</pre></code>
|}

<code>/root/asp/var/log/app.0</code> file (on node WorkerI1) , we should see the dynamically created component getting assigned STANDBY state:

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffffaa;" align="center"| /root/asp/var/log/app.0
|-
|<code><pre>

Wed Sep 3 16:07:43 2008 (WorkerI1.23159 : dummyComp_EO.---.---.00031 : INFO) Component [dynamicComp1] : PID [14623]. Initializing

Wed Sep 3 16:07:43 2008 (WorkerI1.23159 : dummyComp_EO.---.---.00032 : INFO) IOC Address : 0x4

Wed Sep 3 16:07:43 2008 (WorkerI1.23159 : dummyComp_EO.---.---.00033 : INFO) IOC Port : 0x80

Wed Sep 3 16:07:43 2008 (WorkerI1.23159 : dummyComp_EO.---.---.00036 : INFO) Component [dynamicComp1] : PID [14623]. CSI Set Received

Wed Sep 3 16:07:43 2008 (WorkerI1.23159 : dummyComp_EO.---.---.00037 : INFO) CSI Flags : [Add One]
Wed Sep 3 16:07:43 2008 (WorkerI1.23159 : dummyComp_EO.---.---.00038 : INFO) CSI Name : [dynamicTwoNCSI]
Wed Sep 3 16:07:43 2008 (WorkerI1.23159 : dummyComp_EO.---.---.00039 : INFO) Name value pairs :
Wed Sep 3 16:07:43 2008 (WorkerI1.23159 : dummyComp_EO.---.---.00040 : INFO) Name : [model]
Wed Sep 3 16:07:43 2008 (WorkerI1.23159 : dummyComp_EO.---.---.00041 : INFO) Value : [twoN]
Wed Sep 3 16:07:43 2008 (WorkerI1.23159 : dummyComp_EO.---.---.00042 : INFO) HA state : [Standby]
Wed Sep 3 16:07:43 2008 (WorkerI1.23159 : dummyComp_EO.---.---.00043 : INFO) Standby Descriptor :
Wed Sep 3 16:07:43 2008 (WorkerI1.23159 : dummyComp_EO.---.---.00044 : INFO) Standby Rank : [1]
Wed Sep 3 16:07:43 2008 (WorkerI1.23159 : dummyComp_EO.---.---.00045 : INFO) Active Component : [dynamicComp0]

</pre></code>
|}

[[File:OpenClovis_Note.png]]Note : The dynamically created component might come up as ACTIVE on WorkerI1 and STANDBY on WorkerI0 or vice versa (depending on the order in which they are launched).

<li>To delete the AMF entities dynamically, lock the dhaDemoSG service group using the following SAFplus Platform Console command.
<code><pre>
# cli[Test:SysCtrlI0:CPM]-> amsLockAssignment sg dhaDemoSG
</pre></code>
and in the <code>/root/asp/var/log/app.0</code> (on node WorkerI0) file, we should see:

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffffaa;" align="center"| /root/asp/var/log/app.0
|-
|<code><pre>

Wed Sep 3 16:34:27 2008 (WorkerI0.17193 : dhaDemo_EO.---.---.00102 : INFO) Component [dhaDemo] : PID [17193]. CSI Set Received

Wed Sep 3 16:34:27 2008 (WorkerI0.17193 : dhaDemo_EO.---.---.00103 : INFO) CSI Flags : [Target One]
Wed Sep 3 16:34:27 2008 (WorkerI0.17193 : dhaDemo_EO.---.---.00104 : INFO) CSI Name : [dhaDemoCSI]
Wed Sep 3 16:34:27 2008 (WorkerI0.17193 : dhaDemo_EO.---.---.00105 : INFO) HA state : [Quiesced]
Wed Sep 3 16:34:27 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00106 : INFO) Running MGMT initialize
Wed Sep 3 16:34:27 2008 (WorkerI0.17193 : dhaDemo_EO.---.---.00109 : INFO) Component [dhaDemo] : PID [17193]. CSI Remove Received

Wed Sep 3 16:34:27 2008 (WorkerI0.17193 : dhaDemo_EO.---.---.00110 : INFO) CSI : dhaDemoCSI

Wed Sep 3 16:34:27 2008 (WorkerI0.17193 : dhaDemo_EO.---.---.00111 : INFO) CSI Flags : 0x2

Wed Sep 3 16:34:27 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00112 : INFO) Running MGMT CCB initialize
Wed Sep 3 16:34:27 2008 (WorkerI0.17193 : dhaDemo_EO.---.---.00113 : NOTICE) Deleting SG [dynamicTwoNSG] and other entities(si, csi, su, comp, etc)
Wed Sep 3 16:34:27 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00114 : INFO) LockI AMS entities
Wed Sep 3 16:34:27 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00115 : INFO) LockA [dynamicTwoNSU0]
Wed Sep 3 16:34:27 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00116 : INFO) LockI [dynamicTwoNSU0]
Wed Sep 3 16:34:27 2008 (WorkerI0.17217 : dummyComp_EO.---.---.00046 : INFO) Component [dynamicComp0] : PID [17217]. CSI Set Received

Wed Sep 3 16:34:27 2008 (WorkerI0.17217 : dummyComp_EO.---.---.00047 : INFO) CSI Flags : [Target One]
Wed Sep 3 16:34:27 2008 (WorkerI0.17217 : dummyComp_EO.---.---.00048 : INFO) CSI Name : [dynamicTwoNCSI]
Wed Sep 3 16:34:27 2008 (WorkerI0.17217 : dummyComp_EO.---.---.00049 : INFO) HA state : [Quiesced]
Wed Sep 3 16:34:27 2008 (WorkerI0.17217 : dummyComp_EO.---.---.00052 : INFO) Component [dynamicComp0] : PID [17217]. CSI Remove Received

Wed Sep 3 16:34:27 2008 (WorkerI0.17217 : dummyComp_EO.---.---.00053 : INFO) CSI : dynamicTwoNCSI

Wed Sep 3 16:34:27 2008 (WorkerI0.17217 : dummyComp_EO.---.---.00054 : INFO) CSI Flags : 0x2

Wed Sep 3 16:34:29 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00117 : INFO) LockA [dynamicTwoNSU1]
Wed Sep 3 16:34:29 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00118 : INFO) LockI [dynamicTwoNSU1]
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00119 : INFO) LockA SI [dynamicTwoNSI]
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00120 : INFO) LockA SG [dynamicTwoNSG]
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00121 : INFO) LockI SG [dynamicTwoNSG]
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00122 : INFO) Delete COMP [dynamicComp0]
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00123 : INFO) Delete COMP [dynamicComp1]
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00124 : INFO) Delete SU [dynamicTwoNSU0]
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00125 : INFO) Delete SU [dynamicTwoNSU1]
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00126 : INFO) Delete CSI [dynamicTwoNCSI]
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00127 : INFO) Delete SI [dynamicTwoNSI]
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00128 : INFO) Deleting SG [dynamicTwoNSG]
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00129 : INFO) CCB Commit Delete
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00130 : INFO) Running CCB finalize
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00131 : INFO) Running MGMT finalize
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.---.---.00132 : NOTICE) Successfully deleted dynamically created SG [dynamicTwoNSG] and other entities(si, csi, su, comp, etc)

</pre></code>
|}

These can be watched in a separate terminal window using <code>tail -f <file_name> </code>

<li>You can continue to observe this create/delete of AMF entities dynamically by unlocking/locking the SG dhaDemoSG.

*To unlock the dhaDemoSG using the SAFplus Platform Console (this will create the AMF entities dynamically):
<code><pre>
# cli[Test:SysCtrlI0:CPM]-> amsUnlock sg dhaDemoSG
</pre></code>

*To lock the dhaDemoSG using the SAFplus Platform Console (this will delete the AMF entities dynamically):
<code><pre>
# cli[Test:SysCtrlI0:CPM]-> amsLockAssignment sg dhaDemoSG
</pre></code>

*To stop the demo and exit, following CLI commands may be used:
<code><pre>
# cli[Test:SysCtrlI0:CPM]-> amsLockAssignment sg dhaDemoSG
# cli[Test:SysCtrlI0:CPM]-> amsLockInstantiation sg dhaDemoSG
# cli[Test:SysCtrlI0:CPM]-> bye
</pre></code>

</ol>

===Summary===

This Sample Application has covered basic dynamic HA functionality, with creation/deletion of AMF entities (SG, SI, CSI, SU, Component, etc) using Clovis AMF management APIs.

Doc:latest/evalguide/dhaDemo

2012-11-16T21:45:59Z

Karthick: /* Code */

==Dynamic HA Evaluation Guide==

===Objective===

This sample application demonstrates dynamic HA (High Availability) functionality. The application has two components : dhaDemo and dummyComp
*dhaDemo creates/deletes the AMF entities (SG, SI, CSI, SU, Component, etc) dynamically.
*dummyComp is a sample SAF component whose binary(executable) will be used while launching the dynamically created component.

===What you will learn===

*How to create a 2N model dynamically by creating/deleting various AMF entities using Clovis AMF management APIs related to Dynamic HA.

===Building the dynamic HA model (dynamicHaDemo) and deploying runtime images===

The Clovis dynamic HA Application is located in : <install_dir>/sdk-5.0/src/examples/dynamicHaDemo

You need to build the model and deploy the runtime images for following nodes : SysCtrlI0, WorkerI0, WorkerI1

It can be done in very similar manner to evaluation system model (eval). For more information about building and deploying a model, please refer to the following section of evalguide: 
Building the Evaluation System and Deploying Runtime Images

===Code===

The application code can be found within the following directory
<project-area_dir>/dynamicHaDemo/src/app/dhaDemo

This sample component is implemented in a single C module (clCompAppMain.c).
It uses the AMF dynamic HA apis to create a 2N SG on the fly using the clAmsMgmtCCB apis.

There is an alternate version of this C file: clCompAppMain_batch.c which uses a faster version of these apis using clAmsMgmtCCBBatch apis.

The batch version of the dynamic HA apis are faster as the AMF entity CRUD operatons are batched/cached on the client side before they are
committed with clAmsMgmtCCBBatchCommit api.

Both the clAmsMgmtCCB and clAmsMgmtCCBBatch versions of the API are declared in clAmsMgmtClientApi.h which needs to be included for usage.

====Start/Stop the application====

The <code>clCompAppAMFCSISet()</code> function is called to set the component's HA state, and the following block of code assigns this requested state to the component, while verbosely detailing this process:

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

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_NOTICE, "Starting dynamic HA demo.");
clprintf(CL_LOG_SEV_NOTICE, "It will create 2N SG : %sSG", BASE_NAME);
rc = clDhaDemoStart();
if(rc != CL_OK)
{
clprintf(CL_LOG_SEV_CRITICAL, "Failed to start dynamic HA demo.");
}

/*
* ---End_APPLICATION_CODE---
*/

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

</pre></code>
|}

* clDhaDemoStart() will start the workload in a separate thread to create the AMF entities (SG, SI, CSI, SU, Components, etc) when the HA state of dhaDemo becomes ACTIVE. In this case dhaDemo will be assigned active state when you unlock the SG 'dhaDemoSG'

{| 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_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---
*/

rc = clDhaDemoStop();
if(rc != CL_OK)
{
clprintf(CL_LOG_SEV_CRITICAL, "Failed to stop dynamic HA demo.");
}

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

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

</pre></code>
|}

* clDhaDemoStop() will start the workload in a separate thread to delete the AMF entities (SG, SI, CSI, SU, Components, etc) only if they are already created, when the HA state of dhaDemo becomes QUIESCED or QUIESCING. In this case dhaDemo will be get QUIESCED state when you lock the unlocked SG 'dhaDemoSG'

====Create/Delete the AMF entities====

* clDhaDemoCreate() contains the code to create various AMF entities dynamically.

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

rc = clAmsMgmtInitialize(&mgmtHandle, NULL, &version);
if(rc != CL_OK)
{
clprintf(CL_LOG_SEV_ERROR, "AmsMgmt initialize returned [%#x]", rc);
return NULL;
}

clDhaExmpExec(("Running MGMT CCB initialize"),
(rc = clAmsMgmtCCBInitialize(mgmtHandle, &ccbHandle)) == CL_OK,
("MGMT CCB initialize returned [%#x]", rc),
goto out1);

/*
* Create the entities only if they are not created already
*/
entity.type = CL_AMS_ENTITY_TYPE_SG;
snprintf(entity.name.value, sizeof(entity.name.value), "%sSG", pBaseName);
entity.name.length = strlen(entity.name.value)+1;

rc = clAmsMgmtEntityGetConfig(mgmtHandle,
&entity,
&pEntityConfig);

clHeapFree(pEntityConfig);

if(rc == CL_OK)
{
clprintf(CL_LOG_SEV_INFO, "Not creating SG[%sSG], it already exist", pBaseName);
goto out2;
}

/* SG doesn't exist, create SG and other entities dynamically*/

/*First create the service hierarchies*/

clprintf(CL_LOG_SEV_NOTICE,
"Creating 2N SG [%sSG] and other entities(si, csi, su, comp, etc)",
pBaseName);

/* Create SG*/
entity.type = CL_AMS_ENTITY_TYPE_SG;
snprintf(entity.name.value, sizeof(entity.name.value),
"%sSG", pBaseName);
entity.name.length = strlen(entity.name.value)+1;

clDhaExmpExec(("Creating SG [%s]",
entity.name.value),
(rc = clAmsMgmtCCBEntityCreate(ccbHandle,
&entity)) == CL_OK,
("SG create returned [%#x]", rc),
goto out2);

/* Create SI*/
entity.type = CL_AMS_ENTITY_TYPE_SI;
snprintf(entity.name.value, sizeof(entity.name.value),
"%sSI", pBaseName);
entity.name.length = strlen(entity.name.value)+1;
clDhaExmpExec( ("Create SI [%s]", entity.name.value),
(rc = clAmsMgmtCCBEntityCreate(ccbHandle, &entity)) == CL_OK,
("SI create returned [%#x]", rc),
goto out2);

...
...
...

/* CCB Commit*/
clDhaExmpExec(("CCB Commit Create"),
(rc = clAmsMgmtCCBCommit(ccbHandle)) == CL_OK,
("CCB commit returned [%#x]", rc),
goto out2);

...
...

</pre></code>
|}

* clDhaDemoDelete() contains the code to delete the created AMF entities dynamically.

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

rc = clAmsMgmtInitialize(&mgmtHandle, NULL, &version);
if(rc != CL_OK)
{
clprintf(CL_LOG_SEV_ERROR, "AmsMgmt initialize returned [%#x]", rc);
return NULL;
}

clDhaExmpExec(("Running MGMT CCB initialize"),
(rc = clAmsMgmtCCBInitialize(mgmtHandle, &ccbHandle)) == CL_OK,
("MGMT CCB initialize returned [%#x]", rc),
goto out1);

/*
* Delete the entities only if they exist
*/
entity.type = CL_AMS_ENTITY_TYPE_SG;
snprintf(entity.name.value, sizeof(entity.name.value), "%sSG", pBaseName);
entity.name.length = strlen(entity.name.value)+1;

rc = clAmsMgmtEntityGetConfig(mgmtHandle,
&entity,
&pEntityConfig);
clHeapFree(pEntityConfig);
if(rc != CL_OK)
{
clprintf(CL_LOG_SEV_INFO, "Not deleting SG[%sSG], SG config get returned [%#x]", pBaseName, rc);
goto out2;

}

/* SG exist, Delete SG and other entities dynamically*/

clprintf(CL_LOG_SEV_NOTICE,
"Deleting SG [%sSG] and other entities(si, csi, su, comp, etc)",
pBaseName);

/*First move entities to lock instantiated mode*/
clDhaExmpExec(("LockI AMS entities"),
(rc = clAmsMgmtTestLockI(mgmtHandle, ccbHandle, pBaseName)) == CL_OK,
("Unlock AMS entities returned [%#x]", rc),
goto out2);

...
...

/* Delete SI*/
entity.type = CL_AMS_ENTITY_TYPE_SI;
snprintf(entity.name.value, sizeof(entity.name.value),
"%sSI", pBaseName);
entity.name.length = strlen(entity.name.value)+1;
clDhaExmpExec( ("Delete SI [%s]", entity.name.value),
(rc = clAmsMgmtCCBEntityDelete(ccbHandle, &entity)) == CL_OK,
("SI delete returned [%#x]", rc),
goto out2);

/* Delete SG*/
entity.type = CL_AMS_ENTITY_TYPE_SG;
snprintf(entity.name.value, sizeof(entity.name.value),
"%sSG", pBaseName);
entity.name.length = strlen(entity.name.value)+1;
clDhaExmpExec(("Deleting SG [%s]",
entity.name.value),
(rc = clAmsMgmtCCBEntityDelete(ccbHandle,
&entity)) == CL_OK,
("SG delete returned [%#x]", rc),
goto out2);

/* CCB Commit*/
clDhaExmpExec(("CCB Commit Delete"),
(rc = clAmsMgmtCCBCommit(ccbHandle)) == CL_OK,
("CCB commit returned [%#x]", rc),
goto out2);

...
...

</pre></code>
|}

====Usage of AMF management APIs for Dynamic HA====

The detailed documentation of AMF management APIs can be found in "OpenClovis API Reference Guide". Please refer "Availability Management Service" section under the High Availability.

===How to Run dhaDemo application and What to Observe===

We will use the SAFplus Platform Console to manipulate the administrative state of the dhaDemoSG service group.

<ol>

<li>Start the SAFplus Platform on all deployed nodes<code><pre>
# cd /root/asp/
# ./etc/init.d/asp start</pre></code>

<li>Start the SAFplus Platform Console<code><pre>
# cd /root/asp/bin
# ./asp_console</pre></code>

<li>Then put the dhaDemoSG service group into lock assignment state using the following commands.<code><pre>
# cli[Test]-> setc master
# cli[Test:SysCtrlI0]-> setc cpm
# cli[Test:SysCtrlI0:CPM]-> amsLockAssignment sg dhaDemoSG
</pre></code>

The logs for dhaDemo application will be logged into file <code>/root/asp/var/log/app.0</code> on node WorkerI0. Viewing these application logs using the <code>tail -f</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/app.0
|-
|<code><pre>

Wed Sep 3 16:03:02 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00031 : INFO) Component [dhaDemo] : PID [21785]. Initializing

Wed Sep 3 16:03:02 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00032 : INFO) IOC Address : 0x3

Wed Sep 3 16:03:02 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00033 : INFO) IOC Port : 0x80

</pre></code>
|}

<li>To create the AMF entities dynamically, unlock the dhaDemoSG service group using the following SAFplus Platform Console command.
<code><pre>
# cli[Test:SysCtrlI0:CPM]-> amsUnlock sg dhaDemoSG
</pre></code>
and in the <code>/root/asp/var/log/app.0</code> file (on node WorkerI0) , we should see:

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffffaa;" align="center"| /root/asp/var/log/app.0
|-
|<code><pre>

Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00036 : INFO) Component [dhaDemo] : PID [21785]. CSI Set Received

Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00037 : INFO) CSI Flags : [Add One]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00038 : INFO) CSI Name : [dhaDemoCSI]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00039 : INFO) Name value pairs :
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00040 : INFO) HA state : [Active]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00041 : INFO) Active Descriptor :
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00042 : INFO) Transition Descriptor : [1]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00043 : INFO) Active Component : [dhaDemo]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00044 : NOTICE) Starting dynamic HA demo.
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00045 : NOTICE) It will create 2N SG : dynamicTwoNSG
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00046 : INFO) Running MGMT initialize
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00047 : INFO) Running MGMT CCB initialize
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00048 : NOTICE) Creating 2N SG [dynamicTwoNSG] and other entities(si, csi, su, comp, etc)
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00049 : INFO) Creating SG [dynamicTwoNSG]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00050 : INFO) Create SI [dynamicTwoNSI]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00051 : INFO) Create CSI [dynamicTwoNCSI]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00052 : INFO) Create SU [dynamicTwoNSU0]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00053 : INFO) Create SU [dynamicTwoNSU1]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00054 : INFO) Create COMP [dynamicComp0]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00055 : INFO) Create COMP [dynamicComp1]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00056 : INFO) CCB Commit Create
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00057 : INFO) Fill SG config
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00058 : INFO) SG config get [dynamicTwoNSG]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00059 : INFO) SG set SI [dynamicTwoNSI]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00060 : INFO) SG set SU [dynamicTwoNSU0]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00061 : INFO) SG set SU [dynamicTwoNSU1]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00062 : INFO) SG set commit
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00063 : INFO) Fill SI config
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00064 : INFO) SI config get [dynamicTwoNSI]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00065 : INFO) SI config set [dynamicTwoNSI]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00066 : INFO) SI set CSI [dynamicTwoNCSI]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00067 : INFO) SI set commit
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00068 : INFO) Fill CSI config
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00069 : INFO) CSI config get [dynamicTwoNCSI]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00070 : INFO) CSI type set [dynamicTwoNCSIType]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00071 : INFO) CSI set nvplist
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00072 : INFO) CSI ccb commit
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00073 : INFO) Fill SU config
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00074 : INFO) SU config get [dynamicTwoNSU0]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00075 : INFO) SU config set [dynamicTwoNSU0]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00076 : INFO) SU config set [dynamicTwoNSU1]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00077 : INFO) SU [dynamicTwoNSU0] add comp [dynamicComp0]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00078 : INFO) SU [dynamicTwoNSU1] add comp [dynamicComp1]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00079 : INFO) SU set commit
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00080 : INFO) Fill NODE config
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00081 : INFO) NODE config get [WorkerI1]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00082 : INFO) Node set SU [dynamicTwoNSU1]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00083 : INFO) NODE config get [WorkerI0]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00084 : INFO) Node set SU [dynamicTwoNSU0]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00085 : INFO) Node set commit
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00086 : INFO) Fill COMP config
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00087 : INFO) COMP config get [dynamicComp0]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00088 : INFO) Comp config set [dynamicComp0]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00089 : INFO) Comp config set [dynamicComp1]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00090 : INFO) Comp set commit
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00091 : INFO) Unlock AMS entities
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00092 : INFO) LockA [dynamicTwoNSU0]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00093 : INFO) Unlock [dynamicTwoNSU0]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00094 : INFO) LockA [dynamicTwoNSU1]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00095 : INFO) Unlock [dynamicTwoNSU1]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00096 : INFO) Unlock SI [dynamicTwoNSI]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00097 : INFO) LockA SG [dynamicTwoNSG]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00098 : INFO) Unlock SG [dynamicTwoNSG]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00099 : INFO) Running CCB finalize
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00100 : INFO) Running MGMT finalize
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00101 : NOTICE) Successfully created 2N SG [dynamicTwoNSG] and its entities(si, csi, su, comp, etc) dynamically

</pre></code>
|}

*The dynamically created components 'dynamicComp0' and 'dynamicComp1' will come up as active/standby. Which can be verified through the logs present at nodes WorkerI0 and WorkerI1.

<code>/root/asp/var/log/app.0</code> file (on node WorkerI0) , we should see the dynamically created component getting assigned ACTIVE state:

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffffaa;" align="center"| /root/asp/var/log/app.0
|-
|<code><pre>

Wed Sep 3 16:07:43 2008 (WorkerI0.22187 : dummyComp_EO.---.---.00031 : INFO) Component [dynamicComp0] : PID [22187]. Initializing

Wed Sep 3 16:07:43 2008 (WorkerI0.22187 : dummyComp_EO.---.---.00032 : INFO) IOC Address : 0x3

Wed Sep 3 16:07:43 2008 (WorkerI0.22187 : dummyComp_EO.---.---.00033 : INFO) IOC Port : 0x81

Wed Sep 3 16:07:43 2008 (WorkerI0.22187 : dummyComp_EO.---.---.00036 : INFO) Component [dynamicComp0] : PID [22187]. CSI Set Received

Wed Sep 3 16:07:43 2008 (WorkerI0.22187 : dummyComp_EO.---.---.00037 : INFO) CSI Flags : [Add One]
Wed Sep 3 16:07:43 2008 (WorkerI0.22187 : dummyComp_EO.---.---.00038 : INFO) CSI Name : [dynamicTwoNCSI]
Wed Sep 3 16:07:43 2008 (WorkerI0.22187 : dummyComp_EO.---.---.00039 : INFO) Name value pairs :
Wed Sep 3 16:07:43 2008 (WorkerI0.22187 : dummyComp_EO.---.---.00040 : INFO) Name : [model]
Wed Sep 3 16:07:43 2008 (WorkerI0.22187 : dummyComp_EO.---.---.00041 : INFO) Value : [twoN]
Wed Sep 3 16:07:43 2008 (WorkerI0.22187 : dummyComp_EO.---.---.00042 : INFO) HA state : [Active]
Wed Sep 3 16:07:43 2008 (WorkerI0.22187 : dummyComp_EO.---.---.00043 : INFO) Active Descriptor :
Wed Sep 3 16:07:43 2008 (WorkerI0.22187 : dummyComp_EO.---.---.00044 : INFO) Transition Descriptor : [1]
Wed Sep 3 16:07:43 2008 (WorkerI0.22187 : dummyComp_EO.---.---.00045 : INFO) Active Component : [dynamicComp0]

</pre></code>
|}

<code>/root/asp/var/log/app.0</code> file (on node WorkerI1) , we should see the dynamically created component getting assigned STANDBY state:

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffffaa;" align="center"| /root/asp/var/log/app.0
|-
|<code><pre>

Wed Sep 3 16:07:43 2008 (WorkerI1.23159 : dummyComp_EO.---.---.00031 : INFO) Component [dynamicComp1] : PID [14623]. Initializing

Wed Sep 3 16:07:43 2008 (WorkerI1.23159 : dummyComp_EO.---.---.00032 : INFO) IOC Address : 0x4

Wed Sep 3 16:07:43 2008 (WorkerI1.23159 : dummyComp_EO.---.---.00033 : INFO) IOC Port : 0x80

Wed Sep 3 16:07:43 2008 (WorkerI1.23159 : dummyComp_EO.---.---.00036 : INFO) Component [dynamicComp1] : PID [14623]. CSI Set Received

Wed Sep 3 16:07:43 2008 (WorkerI1.23159 : dummyComp_EO.---.---.00037 : INFO) CSI Flags : [Add One]
Wed Sep 3 16:07:43 2008 (WorkerI1.23159 : dummyComp_EO.---.---.00038 : INFO) CSI Name : [dynamicTwoNCSI]
Wed Sep 3 16:07:43 2008 (WorkerI1.23159 : dummyComp_EO.---.---.00039 : INFO) Name value pairs :
Wed Sep 3 16:07:43 2008 (WorkerI1.23159 : dummyComp_EO.---.---.00040 : INFO) Name : [model]
Wed Sep 3 16:07:43 2008 (WorkerI1.23159 : dummyComp_EO.---.---.00041 : INFO) Value : [twoN]
Wed Sep 3 16:07:43 2008 (WorkerI1.23159 : dummyComp_EO.---.---.00042 : INFO) HA state : [Standby]
Wed Sep 3 16:07:43 2008 (WorkerI1.23159 : dummyComp_EO.---.---.00043 : INFO) Standby Descriptor :
Wed Sep 3 16:07:43 2008 (WorkerI1.23159 : dummyComp_EO.---.---.00044 : INFO) Standby Rank : [1]
Wed Sep 3 16:07:43 2008 (WorkerI1.23159 : dummyComp_EO.---.---.00045 : INFO) Active Component : [dynamicComp0]

</pre></code>
|}

[[File:OpenClovis_Note.png]]Note : The dynamically created component might come up as ACTIVE on WorkerI1 and STANDBY on WorkerI0 or vice versa (depending on the order in which they are launched).

<li>To delete the AMF entities dynamically, lock the dhaDemoSG service group using the following SAFplus Platform Console command.
<code><pre>
# cli[Test:SysCtrlI0:CPM]-> amsLockAssignment sg dhaDemoSG
</pre></code>
and in the <code>/root/asp/var/log/app.0</code> (on node WorkerI0) file, we should see:

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffffaa;" align="center"| /root/asp/var/log/app.0
|-
|<code><pre>

Wed Sep 3 16:34:27 2008 (WorkerI0.17193 : dhaDemo_EO.---.---.00102 : INFO) Component [dhaDemo] : PID [17193]. CSI Set Received

Wed Sep 3 16:34:27 2008 (WorkerI0.17193 : dhaDemo_EO.---.---.00103 : INFO) CSI Flags : [Target One]
Wed Sep 3 16:34:27 2008 (WorkerI0.17193 : dhaDemo_EO.---.---.00104 : INFO) CSI Name : [dhaDemoCSI]
Wed Sep 3 16:34:27 2008 (WorkerI0.17193 : dhaDemo_EO.---.---.00105 : INFO) HA state : [Quiesced]
Wed Sep 3 16:34:27 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00106 : INFO) Running MGMT initialize
Wed Sep 3 16:34:27 2008 (WorkerI0.17193 : dhaDemo_EO.---.---.00109 : INFO) Component [dhaDemo] : PID [17193]. CSI Remove Received

Wed Sep 3 16:34:27 2008 (WorkerI0.17193 : dhaDemo_EO.---.---.00110 : INFO) CSI : dhaDemoCSI

Wed Sep 3 16:34:27 2008 (WorkerI0.17193 : dhaDemo_EO.---.---.00111 : INFO) CSI Flags : 0x2

Wed Sep 3 16:34:27 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00112 : INFO) Running MGMT CCB initialize
Wed Sep 3 16:34:27 2008 (WorkerI0.17193 : dhaDemo_EO.---.---.00113 : NOTICE) Deleting SG [dynamicTwoNSG] and other entities(si, csi, su, comp, etc)
Wed Sep 3 16:34:27 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00114 : INFO) LockI AMS entities
Wed Sep 3 16:34:27 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00115 : INFO) LockA [dynamicTwoNSU0]
Wed Sep 3 16:34:27 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00116 : INFO) LockI [dynamicTwoNSU0]
Wed Sep 3 16:34:27 2008 (WorkerI0.17217 : dummyComp_EO.---.---.00046 : INFO) Component [dynamicComp0] : PID [17217]. CSI Set Received

Wed Sep 3 16:34:27 2008 (WorkerI0.17217 : dummyComp_EO.---.---.00047 : INFO) CSI Flags : [Target One]
Wed Sep 3 16:34:27 2008 (WorkerI0.17217 : dummyComp_EO.---.---.00048 : INFO) CSI Name : [dynamicTwoNCSI]
Wed Sep 3 16:34:27 2008 (WorkerI0.17217 : dummyComp_EO.---.---.00049 : INFO) HA state : [Quiesced]
Wed Sep 3 16:34:27 2008 (WorkerI0.17217 : dummyComp_EO.---.---.00052 : INFO) Component [dynamicComp0] : PID [17217]. CSI Remove Received

Wed Sep 3 16:34:27 2008 (WorkerI0.17217 : dummyComp_EO.---.---.00053 : INFO) CSI : dynamicTwoNCSI

Wed Sep 3 16:34:27 2008 (WorkerI0.17217 : dummyComp_EO.---.---.00054 : INFO) CSI Flags : 0x2

Wed Sep 3 16:34:29 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00117 : INFO) LockA [dynamicTwoNSU1]
Wed Sep 3 16:34:29 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00118 : INFO) LockI [dynamicTwoNSU1]
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00119 : INFO) LockA SI [dynamicTwoNSI]
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00120 : INFO) LockA SG [dynamicTwoNSG]
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00121 : INFO) LockI SG [dynamicTwoNSG]
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00122 : INFO) Delete COMP [dynamicComp0]
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00123 : INFO) Delete COMP [dynamicComp1]
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00124 : INFO) Delete SU [dynamicTwoNSU0]
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00125 : INFO) Delete SU [dynamicTwoNSU1]
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00126 : INFO) Delete CSI [dynamicTwoNCSI]
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00127 : INFO) Delete SI [dynamicTwoNSI]
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00128 : INFO) Deleting SG [dynamicTwoNSG]
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00129 : INFO) CCB Commit Delete
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00130 : INFO) Running CCB finalize
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00131 : INFO) Running MGMT finalize
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.---.---.00132 : NOTICE) Successfully deleted dynamically created SG [dynamicTwoNSG] and other entities(si, csi, su, comp, etc)

</pre></code>
|}

These can be watched in a separate terminal window using <code>tail -f <file_name> </code>

<li>You can continue to observe this create/delete of AMF entities dynamically by unlocking/locking the SG dhaDemoSG.

*To unlock the dhaDemoSG using the SAFplus Platform Console (this will create the AMF entities dynamically):
<code><pre>
# cli[Test:SysCtrlI0:CPM]-> amsUnlock sg dhaDemoSG
</pre></code>

*To lock the dhaDemoSG using the SAFplus Platform Console (this will delete the AMF entities dynamically):
<code><pre>
# cli[Test:SysCtrlI0:CPM]-> amsLockAssignment sg dhaDemoSG
</pre></code>

*To stop the demo and exit, following CLI commands may be used:
<code><pre>
# cli[Test:SysCtrlI0:CPM]-> amsLockAssignment sg dhaDemoSG
# cli[Test:SysCtrlI0:CPM]-> amsLockInstantiation sg dhaDemoSG
# cli[Test:SysCtrlI0:CPM]-> bye
</pre></code>

</ol>

===Summary===

This Sample Application has covered basic dynamic HA functionality, with creation/deletion of AMF entities (SG, SI, CSI, SU, Component, etc) using Clovis AMF management APIs.

Doc:latest/evalguide/dhaDemo

2012-11-16T21:44:32Z

Karthick: /* Code */

==Dynamic HA Evaluation Guide==

===Objective===

This sample application demonstrates dynamic HA (High Availability) functionality. The application has two components : dhaDemo and dummyComp
*dhaDemo creates/deletes the AMF entities (SG, SI, CSI, SU, Component, etc) dynamically.
*dummyComp is a sample SAF component whose binary(executable) will be used while launching the dynamically created component.

===What you will learn===

*How to create a 2N model dynamically by creating/deleting various AMF entities using Clovis AMF management APIs related to Dynamic HA.

===Building the dynamic HA model (dynamicHaDemo) and deploying runtime images===

The Clovis dynamic HA Application is located in : <install_dir>/sdk-5.0/src/examples/dynamicHaDemo

You need to build the model and deploy the runtime images for following nodes : SysCtrlI0, WorkerI0, WorkerI1

It can be done in very similar manner to evaluation system model (eval). For more information about building and deploying a model, please refer to the following section of evalguide: 
Building the Evaluation System and Deploying Runtime Images

===Code===

The application code can be found within the following directory
<project-area_dir>/dynamicHaDemo/src/app/dhaDemo

This sample component is implemented in a single C module (clCompAppMain.c).
It uses the AMF dynamic HA apis to create a 2N SG on the fly using the clAmsMgmtCCB apis.

There is an alternate version of this C file: clCompAppMain_batch.c which uses a faster version of these apis using clAmsMgmtCCBBatch apis.

The batch version of the dynamic HA apis are faster as the AMF entity CRUD operatons are batched/cached on the client side before they are
committed with clAmsMgmtCCBBatchCommit api.

====Start/Stop the application====

The <code>clCompAppAMFCSISet()</code> function is called to set the component's HA state, and the following block of code assigns this requested state to the component, while verbosely detailing this process:

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

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_NOTICE, "Starting dynamic HA demo.");
clprintf(CL_LOG_SEV_NOTICE, "It will create 2N SG : %sSG", BASE_NAME);
rc = clDhaDemoStart();
if(rc != CL_OK)
{
clprintf(CL_LOG_SEV_CRITICAL, "Failed to start dynamic HA demo.");
}

/*
* ---End_APPLICATION_CODE---
*/

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

</pre></code>
|}

* clDhaDemoStart() will start the workload in a separate thread to create the AMF entities (SG, SI, CSI, SU, Components, etc) when the HA state of dhaDemo becomes ACTIVE. In this case dhaDemo will be assigned active state when you unlock the SG 'dhaDemoSG'

{| 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_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---
*/

rc = clDhaDemoStop();
if(rc != CL_OK)
{
clprintf(CL_LOG_SEV_CRITICAL, "Failed to stop dynamic HA demo.");
}

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

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

</pre></code>
|}

* clDhaDemoStop() will start the workload in a separate thread to delete the AMF entities (SG, SI, CSI, SU, Components, etc) only if they are already created, when the HA state of dhaDemo becomes QUIESCED or QUIESCING. In this case dhaDemo will be get QUIESCED state when you lock the unlocked SG 'dhaDemoSG'

====Create/Delete the AMF entities====

* clDhaDemoCreate() contains the code to create various AMF entities dynamically.

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

rc = clAmsMgmtInitialize(&mgmtHandle, NULL, &version);
if(rc != CL_OK)
{
clprintf(CL_LOG_SEV_ERROR, "AmsMgmt initialize returned [%#x]", rc);
return NULL;
}

clDhaExmpExec(("Running MGMT CCB initialize"),
(rc = clAmsMgmtCCBInitialize(mgmtHandle, &ccbHandle)) == CL_OK,
("MGMT CCB initialize returned [%#x]", rc),
goto out1);

/*
* Create the entities only if they are not created already
*/
entity.type = CL_AMS_ENTITY_TYPE_SG;
snprintf(entity.name.value, sizeof(entity.name.value), "%sSG", pBaseName);
entity.name.length = strlen(entity.name.value)+1;

rc = clAmsMgmtEntityGetConfig(mgmtHandle,
&entity,
&pEntityConfig);

clHeapFree(pEntityConfig);

if(rc == CL_OK)
{
clprintf(CL_LOG_SEV_INFO, "Not creating SG[%sSG], it already exist", pBaseName);
goto out2;
}

/* SG doesn't exist, create SG and other entities dynamically*/

/*First create the service hierarchies*/

clprintf(CL_LOG_SEV_NOTICE,
"Creating 2N SG [%sSG] and other entities(si, csi, su, comp, etc)",
pBaseName);

/* Create SG*/
entity.type = CL_AMS_ENTITY_TYPE_SG;
snprintf(entity.name.value, sizeof(entity.name.value),
"%sSG", pBaseName);
entity.name.length = strlen(entity.name.value)+1;

clDhaExmpExec(("Creating SG [%s]",
entity.name.value),
(rc = clAmsMgmtCCBEntityCreate(ccbHandle,
&entity)) == CL_OK,
("SG create returned [%#x]", rc),
goto out2);

/* Create SI*/
entity.type = CL_AMS_ENTITY_TYPE_SI;
snprintf(entity.name.value, sizeof(entity.name.value),
"%sSI", pBaseName);
entity.name.length = strlen(entity.name.value)+1;
clDhaExmpExec( ("Create SI [%s]", entity.name.value),
(rc = clAmsMgmtCCBEntityCreate(ccbHandle, &entity)) == CL_OK,
("SI create returned [%#x]", rc),
goto out2);

...
...
...

/* CCB Commit*/
clDhaExmpExec(("CCB Commit Create"),
(rc = clAmsMgmtCCBCommit(ccbHandle)) == CL_OK,
("CCB commit returned [%#x]", rc),
goto out2);

...
...

</pre></code>
|}

* clDhaDemoDelete() contains the code to delete the created AMF entities dynamically.

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

rc = clAmsMgmtInitialize(&mgmtHandle, NULL, &version);
if(rc != CL_OK)
{
clprintf(CL_LOG_SEV_ERROR, "AmsMgmt initialize returned [%#x]", rc);
return NULL;
}

clDhaExmpExec(("Running MGMT CCB initialize"),
(rc = clAmsMgmtCCBInitialize(mgmtHandle, &ccbHandle)) == CL_OK,
("MGMT CCB initialize returned [%#x]", rc),
goto out1);

/*
* Delete the entities only if they exist
*/
entity.type = CL_AMS_ENTITY_TYPE_SG;
snprintf(entity.name.value, sizeof(entity.name.value), "%sSG", pBaseName);
entity.name.length = strlen(entity.name.value)+1;

rc = clAmsMgmtEntityGetConfig(mgmtHandle,
&entity,
&pEntityConfig);
clHeapFree(pEntityConfig);
if(rc != CL_OK)
{
clprintf(CL_LOG_SEV_INFO, "Not deleting SG[%sSG], SG config get returned [%#x]", pBaseName, rc);
goto out2;

}

/* SG exist, Delete SG and other entities dynamically*/

clprintf(CL_LOG_SEV_NOTICE,
"Deleting SG [%sSG] and other entities(si, csi, su, comp, etc)",
pBaseName);

/*First move entities to lock instantiated mode*/
clDhaExmpExec(("LockI AMS entities"),
(rc = clAmsMgmtTestLockI(mgmtHandle, ccbHandle, pBaseName)) == CL_OK,
("Unlock AMS entities returned [%#x]", rc),
goto out2);

...
...

/* Delete SI*/
entity.type = CL_AMS_ENTITY_TYPE_SI;
snprintf(entity.name.value, sizeof(entity.name.value),
"%sSI", pBaseName);
entity.name.length = strlen(entity.name.value)+1;
clDhaExmpExec( ("Delete SI [%s]", entity.name.value),
(rc = clAmsMgmtCCBEntityDelete(ccbHandle, &entity)) == CL_OK,
("SI delete returned [%#x]", rc),
goto out2);

/* Delete SG*/
entity.type = CL_AMS_ENTITY_TYPE_SG;
snprintf(entity.name.value, sizeof(entity.name.value),
"%sSG", pBaseName);
entity.name.length = strlen(entity.name.value)+1;
clDhaExmpExec(("Deleting SG [%s]",
entity.name.value),
(rc = clAmsMgmtCCBEntityDelete(ccbHandle,
&entity)) == CL_OK,
("SG delete returned [%#x]", rc),
goto out2);

/* CCB Commit*/
clDhaExmpExec(("CCB Commit Delete"),
(rc = clAmsMgmtCCBCommit(ccbHandle)) == CL_OK,
("CCB commit returned [%#x]", rc),
goto out2);

...
...

</pre></code>
|}

====Usage of AMF management APIs for Dynamic HA====

The detailed documentation of AMF management APIs can be found in "OpenClovis API Reference Guide". Please refer "Availability Management Service" section under the High Availability.

===How to Run dhaDemo application and What to Observe===

We will use the SAFplus Platform Console to manipulate the administrative state of the dhaDemoSG service group.

<ol>

<li>Start the SAFplus Platform on all deployed nodes<code><pre>
# cd /root/asp/
# ./etc/init.d/asp start</pre></code>

<li>Start the SAFplus Platform Console<code><pre>
# cd /root/asp/bin
# ./asp_console</pre></code>

<li>Then put the dhaDemoSG service group into lock assignment state using the following commands.<code><pre>
# cli[Test]-> setc master
# cli[Test:SysCtrlI0]-> setc cpm
# cli[Test:SysCtrlI0:CPM]-> amsLockAssignment sg dhaDemoSG
</pre></code>

The logs for dhaDemo application will be logged into file <code>/root/asp/var/log/app.0</code> on node WorkerI0. Viewing these application logs using the <code>tail -f</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/app.0
|-
|<code><pre>

Wed Sep 3 16:03:02 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00031 : INFO) Component [dhaDemo] : PID [21785]. Initializing

Wed Sep 3 16:03:02 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00032 : INFO) IOC Address : 0x3

Wed Sep 3 16:03:02 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00033 : INFO) IOC Port : 0x80

</pre></code>
|}

<li>To create the AMF entities dynamically, unlock the dhaDemoSG service group using the following SAFplus Platform Console command.
<code><pre>
# cli[Test:SysCtrlI0:CPM]-> amsUnlock sg dhaDemoSG
</pre></code>
and in the <code>/root/asp/var/log/app.0</code> file (on node WorkerI0) , we should see:

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffffaa;" align="center"| /root/asp/var/log/app.0
|-
|<code><pre>

Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00036 : INFO) Component [dhaDemo] : PID [21785]. CSI Set Received

Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00037 : INFO) CSI Flags : [Add One]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00038 : INFO) CSI Name : [dhaDemoCSI]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00039 : INFO) Name value pairs :
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00040 : INFO) HA state : [Active]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00041 : INFO) Active Descriptor :
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00042 : INFO) Transition Descriptor : [1]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00043 : INFO) Active Component : [dhaDemo]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00044 : NOTICE) Starting dynamic HA demo.
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00045 : NOTICE) It will create 2N SG : dynamicTwoNSG
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00046 : INFO) Running MGMT initialize
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00047 : INFO) Running MGMT CCB initialize
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00048 : NOTICE) Creating 2N SG [dynamicTwoNSG] and other entities(si, csi, su, comp, etc)
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00049 : INFO) Creating SG [dynamicTwoNSG]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00050 : INFO) Create SI [dynamicTwoNSI]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00051 : INFO) Create CSI [dynamicTwoNCSI]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00052 : INFO) Create SU [dynamicTwoNSU0]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00053 : INFO) Create SU [dynamicTwoNSU1]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00054 : INFO) Create COMP [dynamicComp0]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00055 : INFO) Create COMP [dynamicComp1]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00056 : INFO) CCB Commit Create
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00057 : INFO) Fill SG config
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00058 : INFO) SG config get [dynamicTwoNSG]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00059 : INFO) SG set SI [dynamicTwoNSI]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00060 : INFO) SG set SU [dynamicTwoNSU0]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00061 : INFO) SG set SU [dynamicTwoNSU1]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00062 : INFO) SG set commit
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00063 : INFO) Fill SI config
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00064 : INFO) SI config get [dynamicTwoNSI]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00065 : INFO) SI config set [dynamicTwoNSI]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00066 : INFO) SI set CSI [dynamicTwoNCSI]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00067 : INFO) SI set commit
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00068 : INFO) Fill CSI config
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00069 : INFO) CSI config get [dynamicTwoNCSI]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00070 : INFO) CSI type set [dynamicTwoNCSIType]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00071 : INFO) CSI set nvplist
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00072 : INFO) CSI ccb commit
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00073 : INFO) Fill SU config
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00074 : INFO) SU config get [dynamicTwoNSU0]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00075 : INFO) SU config set [dynamicTwoNSU0]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00076 : INFO) SU config set [dynamicTwoNSU1]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00077 : INFO) SU [dynamicTwoNSU0] add comp [dynamicComp0]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00078 : INFO) SU [dynamicTwoNSU1] add comp [dynamicComp1]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00079 : INFO) SU set commit
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00080 : INFO) Fill NODE config
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00081 : INFO) NODE config get [WorkerI1]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00082 : INFO) Node set SU [dynamicTwoNSU1]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00083 : INFO) NODE config get [WorkerI0]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00084 : INFO) Node set SU [dynamicTwoNSU0]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00085 : INFO) Node set commit
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00086 : INFO) Fill COMP config
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00087 : INFO) COMP config get [dynamicComp0]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00088 : INFO) Comp config set [dynamicComp0]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00089 : INFO) Comp config set [dynamicComp1]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00090 : INFO) Comp set commit
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00091 : INFO) Unlock AMS entities
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00092 : INFO) LockA [dynamicTwoNSU0]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00093 : INFO) Unlock [dynamicTwoNSU0]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00094 : INFO) LockA [dynamicTwoNSU1]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00095 : INFO) Unlock [dynamicTwoNSU1]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00096 : INFO) Unlock SI [dynamicTwoNSI]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00097 : INFO) LockA SG [dynamicTwoNSG]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00098 : INFO) Unlock SG [dynamicTwoNSG]
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00099 : INFO) Running CCB finalize
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.DHA.DMO.00100 : INFO) Running MGMT finalize
Wed Sep 3 16:07:33 2008 (WorkerI0.21785 : dhaDemo_EO.---.---.00101 : NOTICE) Successfully created 2N SG [dynamicTwoNSG] and its entities(si, csi, su, comp, etc) dynamically

</pre></code>
|}

*The dynamically created components 'dynamicComp0' and 'dynamicComp1' will come up as active/standby. Which can be verified through the logs present at nodes WorkerI0 and WorkerI1.

<code>/root/asp/var/log/app.0</code> file (on node WorkerI0) , we should see the dynamically created component getting assigned ACTIVE state:

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffffaa;" align="center"| /root/asp/var/log/app.0
|-
|<code><pre>

Wed Sep 3 16:07:43 2008 (WorkerI0.22187 : dummyComp_EO.---.---.00031 : INFO) Component [dynamicComp0] : PID [22187]. Initializing

Wed Sep 3 16:07:43 2008 (WorkerI0.22187 : dummyComp_EO.---.---.00032 : INFO) IOC Address : 0x3

Wed Sep 3 16:07:43 2008 (WorkerI0.22187 : dummyComp_EO.---.---.00033 : INFO) IOC Port : 0x81

Wed Sep 3 16:07:43 2008 (WorkerI0.22187 : dummyComp_EO.---.---.00036 : INFO) Component [dynamicComp0] : PID [22187]. CSI Set Received

Wed Sep 3 16:07:43 2008 (WorkerI0.22187 : dummyComp_EO.---.---.00037 : INFO) CSI Flags : [Add One]
Wed Sep 3 16:07:43 2008 (WorkerI0.22187 : dummyComp_EO.---.---.00038 : INFO) CSI Name : [dynamicTwoNCSI]
Wed Sep 3 16:07:43 2008 (WorkerI0.22187 : dummyComp_EO.---.---.00039 : INFO) Name value pairs :
Wed Sep 3 16:07:43 2008 (WorkerI0.22187 : dummyComp_EO.---.---.00040 : INFO) Name : [model]
Wed Sep 3 16:07:43 2008 (WorkerI0.22187 : dummyComp_EO.---.---.00041 : INFO) Value : [twoN]
Wed Sep 3 16:07:43 2008 (WorkerI0.22187 : dummyComp_EO.---.---.00042 : INFO) HA state : [Active]
Wed Sep 3 16:07:43 2008 (WorkerI0.22187 : dummyComp_EO.---.---.00043 : INFO) Active Descriptor :
Wed Sep 3 16:07:43 2008 (WorkerI0.22187 : dummyComp_EO.---.---.00044 : INFO) Transition Descriptor : [1]
Wed Sep 3 16:07:43 2008 (WorkerI0.22187 : dummyComp_EO.---.---.00045 : INFO) Active Component : [dynamicComp0]

</pre></code>
|}

<code>/root/asp/var/log/app.0</code> file (on node WorkerI1) , we should see the dynamically created component getting assigned STANDBY state:

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffffaa;" align="center"| /root/asp/var/log/app.0
|-
|<code><pre>

Wed Sep 3 16:07:43 2008 (WorkerI1.23159 : dummyComp_EO.---.---.00031 : INFO) Component [dynamicComp1] : PID [14623]. Initializing

Wed Sep 3 16:07:43 2008 (WorkerI1.23159 : dummyComp_EO.---.---.00032 : INFO) IOC Address : 0x4

Wed Sep 3 16:07:43 2008 (WorkerI1.23159 : dummyComp_EO.---.---.00033 : INFO) IOC Port : 0x80

Wed Sep 3 16:07:43 2008 (WorkerI1.23159 : dummyComp_EO.---.---.00036 : INFO) Component [dynamicComp1] : PID [14623]. CSI Set Received

Wed Sep 3 16:07:43 2008 (WorkerI1.23159 : dummyComp_EO.---.---.00037 : INFO) CSI Flags : [Add One]
Wed Sep 3 16:07:43 2008 (WorkerI1.23159 : dummyComp_EO.---.---.00038 : INFO) CSI Name : [dynamicTwoNCSI]
Wed Sep 3 16:07:43 2008 (WorkerI1.23159 : dummyComp_EO.---.---.00039 : INFO) Name value pairs :
Wed Sep 3 16:07:43 2008 (WorkerI1.23159 : dummyComp_EO.---.---.00040 : INFO) Name : [model]
Wed Sep 3 16:07:43 2008 (WorkerI1.23159 : dummyComp_EO.---.---.00041 : INFO) Value : [twoN]
Wed Sep 3 16:07:43 2008 (WorkerI1.23159 : dummyComp_EO.---.---.00042 : INFO) HA state : [Standby]
Wed Sep 3 16:07:43 2008 (WorkerI1.23159 : dummyComp_EO.---.---.00043 : INFO) Standby Descriptor :
Wed Sep 3 16:07:43 2008 (WorkerI1.23159 : dummyComp_EO.---.---.00044 : INFO) Standby Rank : [1]
Wed Sep 3 16:07:43 2008 (WorkerI1.23159 : dummyComp_EO.---.---.00045 : INFO) Active Component : [dynamicComp0]

</pre></code>
|}

[[File:OpenClovis_Note.png]]Note : The dynamically created component might come up as ACTIVE on WorkerI1 and STANDBY on WorkerI0 or vice versa (depending on the order in which they are launched).

<li>To delete the AMF entities dynamically, lock the dhaDemoSG service group using the following SAFplus Platform Console command.
<code><pre>
# cli[Test:SysCtrlI0:CPM]-> amsLockAssignment sg dhaDemoSG
</pre></code>
and in the <code>/root/asp/var/log/app.0</code> (on node WorkerI0) file, we should see:

{| cellspacing="0" cellpadding = "0" border="0" align = "center" width="680"
! style="color:black;background-color:#ffffaa;" align="center"| /root/asp/var/log/app.0
|-
|<code><pre>

Wed Sep 3 16:34:27 2008 (WorkerI0.17193 : dhaDemo_EO.---.---.00102 : INFO) Component [dhaDemo] : PID [17193]. CSI Set Received

Wed Sep 3 16:34:27 2008 (WorkerI0.17193 : dhaDemo_EO.---.---.00103 : INFO) CSI Flags : [Target One]
Wed Sep 3 16:34:27 2008 (WorkerI0.17193 : dhaDemo_EO.---.---.00104 : INFO) CSI Name : [dhaDemoCSI]
Wed Sep 3 16:34:27 2008 (WorkerI0.17193 : dhaDemo_EO.---.---.00105 : INFO) HA state : [Quiesced]
Wed Sep 3 16:34:27 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00106 : INFO) Running MGMT initialize
Wed Sep 3 16:34:27 2008 (WorkerI0.17193 : dhaDemo_EO.---.---.00109 : INFO) Component [dhaDemo] : PID [17193]. CSI Remove Received

Wed Sep 3 16:34:27 2008 (WorkerI0.17193 : dhaDemo_EO.---.---.00110 : INFO) CSI : dhaDemoCSI

Wed Sep 3 16:34:27 2008 (WorkerI0.17193 : dhaDemo_EO.---.---.00111 : INFO) CSI Flags : 0x2

Wed Sep 3 16:34:27 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00112 : INFO) Running MGMT CCB initialize
Wed Sep 3 16:34:27 2008 (WorkerI0.17193 : dhaDemo_EO.---.---.00113 : NOTICE) Deleting SG [dynamicTwoNSG] and other entities(si, csi, su, comp, etc)
Wed Sep 3 16:34:27 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00114 : INFO) LockI AMS entities
Wed Sep 3 16:34:27 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00115 : INFO) LockA [dynamicTwoNSU0]
Wed Sep 3 16:34:27 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00116 : INFO) LockI [dynamicTwoNSU0]
Wed Sep 3 16:34:27 2008 (WorkerI0.17217 : dummyComp_EO.---.---.00046 : INFO) Component [dynamicComp0] : PID [17217]. CSI Set Received

Wed Sep 3 16:34:27 2008 (WorkerI0.17217 : dummyComp_EO.---.---.00047 : INFO) CSI Flags : [Target One]
Wed Sep 3 16:34:27 2008 (WorkerI0.17217 : dummyComp_EO.---.---.00048 : INFO) CSI Name : [dynamicTwoNCSI]
Wed Sep 3 16:34:27 2008 (WorkerI0.17217 : dummyComp_EO.---.---.00049 : INFO) HA state : [Quiesced]
Wed Sep 3 16:34:27 2008 (WorkerI0.17217 : dummyComp_EO.---.---.00052 : INFO) Component [dynamicComp0] : PID [17217]. CSI Remove Received

Wed Sep 3 16:34:27 2008 (WorkerI0.17217 : dummyComp_EO.---.---.00053 : INFO) CSI : dynamicTwoNCSI

Wed Sep 3 16:34:27 2008 (WorkerI0.17217 : dummyComp_EO.---.---.00054 : INFO) CSI Flags : 0x2

Wed Sep 3 16:34:29 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00117 : INFO) LockA [dynamicTwoNSU1]
Wed Sep 3 16:34:29 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00118 : INFO) LockI [dynamicTwoNSU1]
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00119 : INFO) LockA SI [dynamicTwoNSI]
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00120 : INFO) LockA SG [dynamicTwoNSG]
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00121 : INFO) LockI SG [dynamicTwoNSG]
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00122 : INFO) Delete COMP [dynamicComp0]
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00123 : INFO) Delete COMP [dynamicComp1]
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00124 : INFO) Delete SU [dynamicTwoNSU0]
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00125 : INFO) Delete SU [dynamicTwoNSU1]
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00126 : INFO) Delete CSI [dynamicTwoNCSI]
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00127 : INFO) Delete SI [dynamicTwoNSI]
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00128 : INFO) Deleting SG [dynamicTwoNSG]
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00129 : INFO) CCB Commit Delete
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00130 : INFO) Running CCB finalize
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.DHA.DMO.00131 : INFO) Running MGMT finalize
Wed Sep 3 16:34:31 2008 (WorkerI0.17193 : dhaDemo_EO.---.---.00132 : NOTICE) Successfully deleted dynamically created SG [dynamicTwoNSG] and other entities(si, csi, su, comp, etc)

</pre></code>
|}

These can be watched in a separate terminal window using <code>tail -f <file_name> </code>

<li>You can continue to observe this create/delete of AMF entities dynamically by unlocking/locking the SG dhaDemoSG.

*To unlock the dhaDemoSG using the SAFplus Platform Console (this will create the AMF entities dynamically):
<code><pre>
# cli[Test:SysCtrlI0:CPM]-> amsUnlock sg dhaDemoSG
</pre></code>

*To lock the dhaDemoSG using the SAFplus Platform Console (this will delete the AMF entities dynamically):
<code><pre>
# cli[Test:SysCtrlI0:CPM]-> amsLockAssignment sg dhaDemoSG
</pre></code>

*To stop the demo and exit, following CLI commands may be used:
<code><pre>
# cli[Test:SysCtrlI0:CPM]-> amsLockAssignment sg dhaDemoSG
# cli[Test:SysCtrlI0:CPM]-> amsLockInstantiation sg dhaDemoSG
# cli[Test:SysCtrlI0:CPM]-> bye
</pre></code>

</ol>

===Summary===

This Sample Application has covered basic dynamic HA functionality, with creation/deletion of AMF entities (SG, SI, CSI, SU, Component, etc) using Clovis AMF management APIs.

Switch your model/image from TIPC to UDP

2012-08-07T02:08:56Z

Karthick: /* Step 1 */

== From Model ==
=== Step 1 ===
- Using IDE open your model, upgrade your model, a xport configure file clTransport.xml will be generated in <your model>/config/clTransport.xml

<?xml version="1.0" encoding="UTF-8"?>
<openClovisAsp\>
<version v0="4.0.0">
<ioc:BootConfig xmlns:ioc="ioc.ecore">
<config>
<default>TIPC</default>
</config>
<xports>
<xport>
<type>TIPC</type>
<plugin>libClTIPC.so</plugin>
</xport>

</xports>

</ioc:BootConfig>
</version>
</openClovisAsp>

=== Step 2 ===
Edit content clTransport.xml with UDP default:

<?xml version="1.0" encoding="UTF-8"?>
<openClovisAsp>
<version v0="4.0.0">
<ioc:BootConfig xmlns:ioc="ioc.ecore">
<xports>
<xport>
<type>UDP</type>
<plugin>libClUDP.so</plugin>
</xport>
</xports>
<multicast address="226.0.1.1" port="9595" />
<heartbeat>
<interval>3000</interval>
<intervalLocal>3000</intervalLocal>
<retries>5</retries>
</heartbeat>
</ioc:BootConfig>
</version>
<openClovisAsp>

UDP use multicast to notification component arrival and departure.

=== Step 3 ===
Add 2 env variables into <model_dir>/src/target.env:
 
export ASP_UDP_SUBNET=<IP Range>/Length
 
export ASP_UDP_LINK_NAME=<your interface>
 
 
'''Example:'''
 
export ASP_UDP_SUBNET=192.168.57.0/24
 
export ASP_UDP_LINK_NAME=eth0
 

=== Step 4 ===
Before running ASP, should export/setenv 2 below variables:
 
export ASP_UDP_SUBNET=192.168.57.0/24
 
export ASP_UDP_LINK_NAME=eth0
 

== From Image ==
Create a clTransport.xml like step 2 & 3 above and retarball your images.

Switch your model/image from TIPC to UDP

2012-08-07T02:08:23Z

Karthick: /* Step 1 */

== From Model ==
=== Step 1 ===
- Using IDE open your model, upgrade your model, a xport configure file clTransport.xml will be generated in <your model>/config/clTransport.xml

<?xml version="1.0" encoding="UTF-8"?>
<openClovisAsp\>
<version v0="4.0.0">
<ioc:BootConfig xmlns:ioc="ioc.ecore">
<config>
<default>TIPC</default>
</config>
<xports>
<xport>
<type>TIPC</type>
<plugin>libClTIPC.so</plugin>
</xport>

</xports>

</ioc:BootConfig>
</version>

</openClovisAsp>

=== Step 2 ===
Edit content clTransport.xml with UDP default:

<?xml version="1.0" encoding="UTF-8"?>
<openClovisAsp>
<version v0="4.0.0">
<ioc:BootConfig xmlns:ioc="ioc.ecore">
<xports>
<xport>
<type>UDP</type>
<plugin>libClUDP.so</plugin>
</xport>
</xports>
<multicast address="226.0.1.1" port="9595" />
<heartbeat>
<interval>3000</interval>
<intervalLocal>3000</intervalLocal>
<retries>5</retries>
</heartbeat>
</ioc:BootConfig>
</version>
<openClovisAsp>

UDP use multicast to notification component arrival and departure.

=== Step 3 ===
Add 2 env variables into <model_dir>/src/target.env:
 
export ASP_UDP_SUBNET=<IP Range>/Length
 
export ASP_UDP_LINK_NAME=<your interface>
 
 
'''Example:'''
 
export ASP_UDP_SUBNET=192.168.57.0/24
 
export ASP_UDP_LINK_NAME=eth0
 

=== Step 4 ===
Before running ASP, should export/setenv 2 below variables:
 
export ASP_UDP_SUBNET=192.168.57.0/24
 
export ASP_UDP_LINK_NAME=eth0
 

== From Image ==
Create a clTransport.xml like step 2 & 3 above and retarball your images.

Building an installation package

2012-03-14T01:20:42Z

Karthick: /* Preparation */

==Create an Installation Package==
*Note: this requires access to OpenClovis private repositories so is only useful for OpenClovis Engineers

=== Preparation ===
# Create a directory "git". "cd" to it.
# Check out SAFplus, and IDE, projects. Rename their subdirectories "SAFplus" and "IDE".
# Detar "eclipse" 3.7.x "indigo", and the following plugins. You should end up with an "eclipse" directory with all plugins properly placed:
## cdt-master-7.0.2.zip, emf-xsd-SDK-2.7.1.zip, GEF-SDK-3.7.2.zip
## These plugins and eclipse are available in the 3rdparty repository, "idedev" subdirectory
# cd "IDE"
# make EclipseDir=eclipse CDTDir=. -f release.mk

Packages will be created in the "git" directory...

Building an installation package

2012-03-14T01:19:35Z

Karthick: /* Preparation */

High Availability (AMF) Questions

2012-02-22T22:18:38Z

Karthick: /* FAQ */

== High Availability (AMF) ==

===Overview===
OpenClovis ASP provides a SA-Forum compliant High Availability solution (the AMF in SAF terminology). This component controls the starting/stopping of applications, application redundancy configuration, and role assignment.

===FAQ===
* '''How to get the IOC address for the given node?'''
: The relevant API is "clCpmIocAddressForNodeGet" in "clCpmExtApi.h".

* '''What’s the best way for an application to determine the name/slot of the currently active controller in the cluster?'''
: The relevant API is "clCpmMasterAddressGet". Example code (which also converts the node's address into its name) is as follows:
<pre>
#include <clCpmExtApi.h>
ClRcT masterNodeGet(void)
{
ClIocNodeAddressT node = 0;
ClRcT rc = clCpmMasterAddressGet(&node);
if(node)
{
ClCpmSlotInfoT slotInfo = {.slotId = node } ;
rc = clCpmSlotGet(CL_CPM_SLOT_ID, &slotInfo);
if(rc == CL_OK)
clLogNotice("MASTER", "GET", " Currently active controller node name is [%.*s]",
slotInfo.nodeName.length, slotInfo.nodeName.value);
}
return rc;
}
</pre>

* '''How does component recovery and escalation work ?'''

If your recovery is component restart and your component is marked as restartable, and it restarts sgconfig.compRestartCountMax within sgconfig.compRestartDuration, then it escalates to SU restart. If the SU restart happens sgconfig.surestartcountmax within sgconfig.surestartduration, then it escalates to SU failover. If SU is not marked as restartable, then it escalates to SU failover. If the SU failover happens nodeconfig.sufailovercountmax within nodeconfig.sufailoverduration, then it escalates to node failover. If the nodeconfig.autorepair is set to TRUE (default), the node is rebooted on node recovery escalations. Also if a component cleanup action fails which typically happens when the configured component cleanup script fails when run on abnormal process exits/crashes, the recovery is escalated to node failover if the compconfig.nodeRebootCleanupFail is set to TRUE (default). The node reboot behavior on escalation/recovery can be controlled by exporting the following environment variables in your MODEL/target.env location thats automatically copied to etc/asp.conf while building the target images with make images.
<pre>
export ASP_NODE_REBOOT_DISABLE=1
</pre>
The above flag would disable reboot of nodes. If the user wants to restart the
middleware or ASP on node recovery, then he could:

<pre>
export ASP_NODE_RESTART=1
</pre>

* '''What is the purpose of each timeout, what happen after the timeout expires?'''

** instantiateTimeout

The component has to respond to AMF instantiation request with saAmfResponse within this time. Otherwise on timeout, amf would kill it and try to relaunch it compConfig.numMaxInstantiate times after which it would try to launch it compConfig.numMaxInstantiate times after compConfig.instantiationDelay. If they fail or timeout, the component is marked INSTANTIATION-FAILED. Recovery from INSTANTIATION-FAILED is intended to happen by operator intervention through an "amfRepaired" operation, accessible via API or debug CLI.

** terminateTimeout

If the component doesn't respond to the appterminate request from AMF within the terminate timeout, it would be marked termination-failed and component cleanup would be issued. (abrupt termination or SIGKILL sent with configured compCleanupScript invocation)

** cleanupTimeout

If component cleanup times out which usually happens when the configured component cleanup script takes more than cleanupTimeout to return during component cleanup trigger and compConfig.nodeRebootCleanupFail is set to TRUE, then node is reset/rebooted (based on env flags in etc/asp.conf. Default is reboot). Otherwise if its false, then SU is failed over on cleanup error.

** amStartTimeout/amStopTimeout

Nothing happens on monitoring these timeouts as its not present and processes can use amf healthcheck with recommended recovery.

** quiescingCompleteTimeout

When the component doesn't respond with saAmfQuiescingComplete within the quiescingcompletetimeout for a component CSI QUIESCING set request, then its configured recovery takes effect.

** csiSetTimeout

Same as above. If the process doesn't respond with saAmfResponse for a csi set request (ACTIVE/STANDBY or QUIESCED), then component recommended recovery takes place.

** csiRemoveTimeout

Same. If the process doesn't respond with saAmfResponse to the amf csiRemove request, then recovery is triggered.

** proxiedCompInstantiateTimeout

This is only true for SAF-proxy-proxied components. If the SA-AWARE proxy doesn't respond with saAmfResponse to the proxiedCompInstantiate request or proxied-non-preinstantiable doesn't respond to the proxied csiset request (BOTH requests sent to the PROXY component) with saAmfResponse within the proxied instantiate timeout, then recovery is triggered for the proxied.

** proxiedCompCleanupTimeout

Again only true for proxy-proxied. If the proxy component doesn't respond to the proxied cleanup callback with saAmfResponse, then a cleanup error for the proxied is processed which is the same as cleanup error for cleanup timeout mentioned above. Either nodeReset if nodeRebootCleanupFail is configured for the component or recovery to SU failover (proxied compcleanup is triggered when proxied component is failed by proxy or fails healthcheck from proxy and proxy returns failure with saAmfResponse or times out the healthcheck for its proxied component which proxy is managing).

* '''How to do a graceful switchover?'''
: A 'graceful' switchover is one where the running applications have a chance to finish ongoing work before the "active" designation is moved to another instance of the applications.
: Graceful switchover must be implemented in your application by handling the SAF "SA_AMF_HA_QUIESCING" flag in the work assignment callback. This callback must initiate the clean up process. When you application is done, it should call "saAmfCSIQuiescingComplete(amfHandle, invocation, SA_AIS_OK);" to tell the AMF that it has finished.
: To trigger a graceful switchover, you can call clAmsMgmtEntityShutdown, or clCpmNodeRestart from any application, or from the ASP debug CLI (within CPM context -- setc master; setc cpm) you can initiate a graceful shutdown by doing "amslockassignment <entity type> <entity name>". Then run "amsunlock <entity type> <entity name>" to bring the entity back into service (as standby). For example, to effect switchover of the node named "controller1" use "amslockassignment node controller1".

High Availability (AMF) Questions

2011-06-16T17:33:25Z

Karthick: /* FAQ */

High Availability (AMF) Questions

2011-06-16T17:28:57Z

Karthick: /* FAQ */

High Availability (AMF) Questions

2011-06-16T17:25:26Z

Karthick: /* FAQ */

Doc:Sdk 4.1/awdguide/apiexamples

2009-07-29T00:40:58Z

Karthick: /* API Examples */

==API Examples==
API documentation is included in this documentation package. Additionally, there are several examples located in the "bin" directory of the distribution. These examples provide a basic overview of the APIs and how to use them and also show some simple client/server implementations.

===Basic API Use Example: apiexample.py===

This is intended to be an interactive example (i.e. cut-and-paste the lines into a Python shell running under SAFplus Platform). It presents an overview of the highest layer of APIs and shows how cluster information can be retrieved, software can be installed, and an upgrade started.

It can be run in any SAFplus-connected python shell. To get to an SAFplus-connected Python shell, either use the shell embedded in the SAFplus Platform web server (browse to /shell), or run one from the command line. To run from the command line (recommended because you get a full-featured standard python shell) do the following:

Set up paths to get ARD libraries:
$ export PYTHONPATH={ardDir}/lib:{ardDir}/bin
$ export PATH={ardDir}/bin:$PATH

Run Python. Make SURE to specify ARD's embedded Python, and not your distribution's installed version!
$ {ASP_Dir}/bin/asp_run {ardDir}/bin/python2.5

Now at the Python prompt, run this line FIRST to hook into the SAFplus Platform AMF:
>> import amfpy; amfpy.initializeAmf()

At this point you can use all ARD Python services, as shown in the following script:

====apiexample.py====

# Standard Python modules
import os
import time

# ARD Python API example code, including deployment and upgrade:
import upgrade; import clusterinfo; import aspApp; import aspAmf; import appdeploy

# Hook into the various services
ci = clusterinfo.ci # The clusterinfo.ci objects reflect the entire state of the cluster
amf = aspAmf.Session() # The aspAmf.Session class lets you modify the cluster state

# Example of getting the node names
print [x.name for x in ci.nodeList]

# Get the name of the node in slot 1
print ci.nodes[1].name

# Example of getting the sg started/stopped status
print "Running Service Groups:"
for x in clusterinfo.ci.sgList:
if x.isRunning():
print x.name

# Example of getting SU status and of traversing the entity hierarchy
print "Active Service Units:"
for x in clusterinfo.ci.suList:
if x.isActive():
print "%s is active for service group %s and is running on node %s (slot: %d)" % (x.name,x.sg.name,x.node.name,x.node.slot)

# Example of stopping and restarting an entity
su = ci.suList[0]
print "Stopping %s" % su.name
amf.Shutdown(su)
# Now we must reload the clusterinfo to reflect changes.
ci.load()
su = ci.entities[su.name] # and reload our temporary. Its best to access your entities by name in case the list order changes
if su.isRunning():
print "SU %s is still running" % su.name
else:
print "SU %s is stopped" % su.name
amf.Startup(su)
ci.load()
su = ci.entities[su.name] # its best to access your entities by name in case the list order changes
if su.isRunning():
print "SU %s is running" % su.name
else:
print "SU %s is still stopped" % su.name

# Initialize the Application bundle DB & pass the bundle repository directory. Note that you should only create 1 of these per bundle repository directory or you will have 2 entities managing the same data.
appDb = aspApp.AppDb(os.getenv("ASP_DIR","/tmp") + "/apps")
ci.setAppDb(appDb) # Hook them up (so clusterinfo knows about application versions)
myNode = "ctrlI0"

# Set additional data that SAFplus Platform may not know into the node
# This info is necessary to deploy software
# (it also can be entered via the GUI, or via etc/clustercfg.xml file)
# You need to change these values to correctly reflect your setup
if ci.entities[myNode].localUser == 'unknown':
ci.entities[myNode].setIntraclusterAccess("192.168.66.130","root","clovis","/root/ocmsdemo7")
# The above example sets 1 node. For the application deployment example
# below to work, you must set all of the nodes to the correct values.

# Add 2 bundle files into the system. Of course you must modify the path to
# point to valid bundle files.
appDb.NewAppFile("/code/vipapp1.4.0.0.tgz")
appDb.NewAppFile("/code/vipapp1.4.0.1.tgz")
# Note that if you want AppDb to automatically find them again,
# you must copy them into the repository (the directory you specified
# when creating "appDb").

# Show all bundles and versions
print [(x.name,x.version) for x in appDb.AppList()]

# Find all "live" nodes
# Of course, you can't deploy to nodes that aren't powered up!
liveNodes = filter(lambda x: x.isRunning(),ci.nodeList)
print [x.name for x in liveNodes]

# Get an application
appFile = appDb.apps['virtualIp'].version['1.4.0.0']
print "Name: ", appFile.name, "Located At: ", appFile.dir, "Version: ", appFile.version

Deploy the application:

# Tweak the configuration for just this deployment
# If I didn't copy the configuration, I would be modifying it in RAM
# which would affect other deployments I do within this Python session.
import copy
newCfg = copy.deepcopy(appFile.cfg)
# For example, set failback parameter to True:
newCfg.virtualIp.modifiers.failBack = True

# Really Deploy
import appdeploy
(sgList,(errors,notes)) = appdeploy.deploy(appFile.dir,newCfg,liveNodes,abortIfCantAccess=True,copy=True,deploy=True)
# Did you get a pexpect exception? You probably forgot to specify the node
# intracluster access data as shown above. Or you may have specified
# incorrect information.
myNewSg = sgList[0]
mySgName = myNewSg.name
print "Deployed application and created SG %s" % mySgName
# Reload the AMF information model
ci.load()

# Reaccess via ci global to get refreshed data.
mySg = ci.entities[mySgName]
# Let's start it up
amf.Startup(mySg)
# Give it time to come up
# I reaccess through ci each time to get refreshed data.
while not ci.entities[mySgName].isRunning():
time.sleep(5)
ci.refresh()
print "It is running"

Let's do an upgrade!

# Start the upgrade manager...
umgr = upgrade.UpgradeMgr()
umgr.add(mySg) # Add my Service Group to it.
upSg = umgr.entities[mySgName] # Get my sg's upgrade entity
upSg.upMethod = upgrade.RollingUpgrade
print mySg.appVer.version

# Start the upgrade...
upSg.Upgrade(appDb.apps['virtualIp'].version['1.4.0.1'])
ci.load() # Reload the database.
mySg = ci.entities[mySg.name] # Get the new SG object
print mySg.appVer.version

===XML client/server example===

This example is located in the "bin" directory and consists of 2 files "xmlclientexample.py" and "xmlserverexample.py". It implements a simple XML-RPC client server application that demonstrates how the ARD can interface with 3rd party off-box element management systems. Please look at these files to see how it works.

===HTTP client/server example===

This example is located in the "bin" directory and consists of 2 files "httpclientexample.py" and "httpserverexample.py". It implements a simple http server application that demonstrates how the ARD can interface with 3rd party off-box element management systems. The intention behind this example is to show a client-server application communicating via http not a human browseable web site (the main ARD GUI application demonstrates how a web-based EMS can be constructed).

Doc:Sdk 4.1/awdguide/apiexamples

2009-07-29T00:40:26Z

Karthick: /* API Examples */

==API Examples==

API documentation is included in this documentation package. Additionally, there are several examples located in the "bin" directory of the distribution. These examples provide a basic overview of the APIs and how to use them and also show some simple client/server implementations.

===Basic API Use Example: apiexample.py===

This is intended to be an interactive example (i.e. cut-and-paste the lines into a Python shell running under SAFplus Platform). It presents an overview of the highest layer of APIs and shows how cluster information can be retrieved, software can be installed, and an upgrade started.

It can be run in any SAFplus-connected python shell. To get to an SAFplus-connected Python shell, either use the shell embedded in the SAFplus Platform web server (browse to /shell), or run one from the command line. To run from the command line (recommended because you get a full-featured standard python shell) do the following:

Set up paths to get ARD libraries:
$ export PYTHONPATH={ardDir}/lib:{ardDir}/bin
$ export PATH={ardDir}/bin:$PATH

Run Python. Make SURE to specify ARD's embedded Python, and not your distribution's installed version!
$ {ASP_Dir}/bin/asp_run {ardDir}/bin/python2.5

Now at the Python prompt, run this line FIRST to hook into the SAFplus Platform AMF:
>> import amfpy; amfpy.initializeAmf()

At this point you can use all ARD Python services, as shown in the following script:

====apiexample.py====

# Standard Python modules
import os
import time

# ARD Python API example code, including deployment and upgrade:
import upgrade; import clusterinfo; import aspApp; import aspAmf; import appdeploy

# Hook into the various services
ci = clusterinfo.ci # The clusterinfo.ci objects reflect the entire state of the cluster
amf = aspAmf.Session() # The aspAmf.Session class lets you modify the cluster state

# Example of getting the node names
print [x.name for x in ci.nodeList]

# Get the name of the node in slot 1
print ci.nodes[1].name

# Example of getting the sg started/stopped status
print "Running Service Groups:"
for x in clusterinfo.ci.sgList:
if x.isRunning():
print x.name

# Example of getting SU status and of traversing the entity hierarchy
print "Active Service Units:"
for x in clusterinfo.ci.suList:
if x.isActive():
print "%s is active for service group %s and is running on node %s (slot: %d)" % (x.name,x.sg.name,x.node.name,x.node.slot)

# Example of stopping and restarting an entity
su = ci.suList[0]
print "Stopping %s" % su.name
amf.Shutdown(su)
# Now we must reload the clusterinfo to reflect changes.
ci.load()
su = ci.entities[su.name] # and reload our temporary. Its best to access your entities by name in case the list order changes
if su.isRunning():
print "SU %s is still running" % su.name
else:
print "SU %s is stopped" % su.name
amf.Startup(su)
ci.load()
su = ci.entities[su.name] # its best to access your entities by name in case the list order changes
if su.isRunning():
print "SU %s is running" % su.name
else:
print "SU %s is still stopped" % su.name

# Initialize the Application bundle DB & pass the bundle repository directory. Note that you should only create 1 of these per bundle repository directory or you will have 2 entities managing the same data.
appDb = aspApp.AppDb(os.getenv("ASP_DIR","/tmp") + "/apps")
ci.setAppDb(appDb) # Hook them up (so clusterinfo knows about application versions)
myNode = "ctrlI0"

# Set additional data that SAFplus Platform may not know into the node
# This info is necessary to deploy software
# (it also can be entered via the GUI, or via etc/clustercfg.xml file)
# You need to change these values to correctly reflect your setup
if ci.entities[myNode].localUser == 'unknown':
ci.entities[myNode].setIntraclusterAccess("192.168.66.130","root","clovis","/root/ocmsdemo7")
# The above example sets 1 node. For the application deployment example
# below to work, you must set all of the nodes to the correct values.

# Add 2 bundle files into the system. Of course you must modify the path to
# point to valid bundle files.
appDb.NewAppFile("/code/vipapp1.4.0.0.tgz")
appDb.NewAppFile("/code/vipapp1.4.0.1.tgz")
# Note that if you want AppDb to automatically find them again,
# you must copy them into the repository (the directory you specified
# when creating "appDb").

# Show all bundles and versions
print [(x.name,x.version) for x in appDb.AppList()]

# Find all "live" nodes
# Of course, you can't deploy to nodes that aren't powered up!
liveNodes = filter(lambda x: x.isRunning(),ci.nodeList)
print [x.name for x in liveNodes]

# Get an application
appFile = appDb.apps['virtualIp'].version['1.4.0.0']
print "Name: ", appFile.name, "Located At: ", appFile.dir, "Version: ", appFile.version

Deploy the application:

# Tweak the configuration for just this deployment
# If I didn't copy the configuration, I would be modifying it in RAM
# which would affect other deployments I do within this Python session.
import copy
newCfg = copy.deepcopy(appFile.cfg)
# For example, set failback parameter to True:
newCfg.virtualIp.modifiers.failBack = True

# Really Deploy
import appdeploy
(sgList,(errors,notes)) = appdeploy.deploy(appFile.dir,newCfg,liveNodes,abortIfCantAccess=True,copy=True,deploy=True)
# Did you get a pexpect exception? You probably forgot to specify the node
# intracluster access data as shown above. Or you may have specified
# incorrect information.
myNewSg = sgList[0]
mySgName = myNewSg.name
print "Deployed application and created SG %s" % mySgName
# Reload the AMF information model
ci.load()

# Reaccess via ci global to get refreshed data.
mySg = ci.entities[mySgName]
# Let's start it up
amf.Startup(mySg)
# Give it time to come up
# I reaccess through ci each time to get refreshed data.
while not ci.entities[mySgName].isRunning():
time.sleep(5)
ci.refresh()
print "It is running"

Let's do an upgrade!

# Start the upgrade manager...
umgr = upgrade.UpgradeMgr()
umgr.add(mySg) # Add my Service Group to it.
upSg = umgr.entities[mySgName] # Get my sg's upgrade entity
upSg.upMethod = upgrade.RollingUpgrade
print mySg.appVer.version

# Start the upgrade...
upSg.Upgrade(appDb.apps['virtualIp'].version['1.4.0.1'])
ci.load() # Reload the database.
mySg = ci.entities[mySg.name] # Get the new SG object
print mySg.appVer.version

===XML client/server example===

This example is located in the "bin" directory and consists of 2 files "xmlclientexample.py" and "xmlserverexample.py". It implements a simple XML-RPC client server application that demonstrates how the ARD can interface with 3rd party off-box element management systems. Please look at these files to see how it works.

===HTTP client/server example===

This example is located in the "bin" directory and consists of 2 files "httpclientexample.py" and "httpserverexample.py". It implements a simple http server application that demonstrates how the ARD can interface with 3rd party off-box element management systems. The intention behind this example is to show a client-server application communicating via http not a human browseable web site (the main ARD GUI application demonstrates how a web-based EMS can be constructed).