1 Introduction
1.1 Document Purpose and Scope
The purpose of this document is to describe how to set up the VIP Front End Management Tool to create, delete, or move VIP Front End Elements (FEE) in the SAPC.
1.2 Revision Information
| Rev. A | This is the first release of this document. | |
1.3 Typographic Conventions
This document uses the following typographic conventions:
|
Convention |
Description |
Example |
|---|---|---|
|
User Input |
A command that you must enter in a Command-Line Interface (CLI) exactly as written. |
ssh root@<<oam-vip> -t -s cli |
|
Command Variables |
Command variables, the values of which you must supply. |
SC-<X> |
|
System Elements |
Command and parameter names, program names, path names, URLs, and directory names |
The files are located in /cluster/storage/system/config/sapc |
|
Output Information |
Text displayed by the system |
Status OK |
2 Overview
Front ends are the elements used by VIP to communicate externally the SAPC with other nodes. During an installation, these front ends are added by the Adapt Cluster Tool. The VIP front ends are added by the Adapt Cluster Tool at installation phase. The VIP Front End Management Tool adds front ends during an expansion or in case more front ends are needed at any other point.
3 Prerequisites
Before starting this procedure, ensure that the following conditions are met:
4 Front End Management Tool
4.1 Tool Purpose
To create, move or delete front ends from a running SAPC deployment without traffic disturbance. Every traffic payload is connected to the external network, but without front ends, no traffic can be processed by the payload. Payloads with front ends have more overhead than the others so it is good to have more front ends depending on the number of payloads in the cluster.
4.2 Front End Management Tool Parameters
Main parameters come from VIP as they are used to configure the new front ends. Those parameters explained as "VIP configuration parameters" imply special VIP knowledge and in case there is a need to modify them, follow VIP documentation.
|
Parameter |
Description |
Example |
|---|---|---|
|
Front ends are grouped under the same functionality using
an ALB to identify it. There are several ones depending
on the purpose. |
alb_trf | |
|
Name of the front end to be created, deleted, or moved. |
fee_1 | |
|
SOURCE_NODE |
Mandatory for dump, show and delete commands, it identifies the PL to which you must apply the command. |
3 |
|
DESTINATION_NODE |
Mandatory for move and create commands, it identifies the PL to which you must apply the command. |
4 |
|
COMMANDS |
VIP configuration parameters. |
["0:iptables_fee_cmd_0", "1:iptables_fee_cmd_1", "2:iptables_fee_cmd_2", "3:iptables_fee_cmd_3", "4:iptables_fee_cmd_4", "5:iptables_fee_cmd_5"] |
|
EXTERNAL_INTERFACE |
VIP configuration parameters. |
bond0.120 |
|
OSPF_DEAD_INTERVAL |
VIP configuration parameters. |
9 |
|
OSPF_HELLO_INTERVAL |
VIP configuration parameters. |
3 |
|
OSPF_LOCAL_ADDRESS |
VIP configuration parameters. |
192.168.216.3/27 |
|
OSPF_RETRANSMIT_INTERVAL |
VIP configuration parameters. |
5 |
|
OSPF_ROUTER_ID |
VIP configuration parameters. |
192.168.216.3 |
|
OSPF_ROUTER_PRIORITY |
VIP configuration parameters. |
0 |
|
OSPF_SPF_DELAY |
VIP configuration parameters. |
500 |
|
OSPF_SPF_INTERVAL |
VIP configuration parameters. |
100 |
|
OSPF_TRANSMIT_DELAY |
VIP configuration parameters. |
1 |
|
OSPF_AREA |
VIP configuration parameters. |
0.0.1.1 |
|
EVIP_SUPERVISED_REMOTE_GATEWAY |
VIP configuration parameters. |
192.168.216.1 |
|
EVIP_SUPERVISED_REMOTE_GATEWAY2 |
VIP configuration parameters. |
192.168.216.2 |
4.3 Front End Management Tool Modes
- Logon on in the SAPC as "root" userId, the system
administrator must use:
Terminal: # ssh root@<OAM VIP> -p <COM Port>
where <OAM VIP> is the SAPC VIP OAM
and <COM Port> is normally 830
ssh root@10.42.118.235 -p 830
- SC-X: # sapcFeeManagement <mode> <source_alb> <source_fee> <source_node> <destination_node>
Execute the tool from the system controller which accesses to the COM.
Five modes are available: move, dump, create, delete, and show.
Move Mode
Moves the front end from the <SOURCE_NODE> to the <DESTINATION_NODE>. Copies all the VIP configuration parameters from one node to the other one. It can be done with traffic as there is no need to use cluster reboot for the configuration to be in place. Keep in mind though that the <DESTINATION_NODE> needs the external networking ready (specially important in NSP deployments).
Example 1 Move a Traffic FEE from PL-3 to PL-7
SC-1:# sapcFeeManagement move alb_trf fee_1 3 7 |
Dump Mode
Dumps the info related to the <ALB>, <FEE>, and <SOURCE_NODE> into a file called sapcFeeManagement.cfg. This file can be used as template to add a new VIP front end.
Example 2 Dump FEE in PL-3
SC-1:# sapcFeeManagement dump alb_trf fee_1 3 |
Create Mode
Creates a front end with the values explained in the file sapcFeeManagement.cfg.
This is the most complex scenario as you need to add all the values of the table, specially the configuration parameters. Normally one front end is used as template by executing the dump mode.
Check that the values are correct before applying it but some hints are explained here.
- EXTERNAL_INTERFACE, EVIP_SUPERVISED_REMOTE_GATEWAY and EVIP_SUPERVISED_REMOTE_GATEWAY2 could change depending on to which gateway the payload is connected to. But if the payload is connected to the same router as the reference one used in the dump command, these values do not change.
- OSPF_LOCAL_ADDRESS and OSPF_ROUTER_ID need spare values in the specific network where the front end is added.
- The rest of parameters normally are equal to the values of existing front ends.
Example 3 Create a FEE
SC-1:# sapcFeeManagement create |
Delete Mode
Deletes an existing front end specified by SOURCE_ALB, SOURCE_FEE and SOURCE_NODE.
Example 4 Delete the "fee_1" FEE in PL-3
SC-1:# sapcFeeManagement delete alb_trf fee_1 3 |
Show Mode
Similar as dump mode, but the info is shown through the console.
Example 5 Show FEE in PL-3
SC-1:# sapcFeeManagement show alb_trf fee_1 3 |
Glossary
| ALB |
| Abstract Load Balancer |
| FEE |
| Front-End Element |
| PL |
| PayLoad |
| PNF |
| Physical Network Function |
| SAPC |
| Ericsson Service-Aware Policy Controller |
| SC |
| System Controller |
| VIP |
| Virtual IP address |
| VR |
| Virtual Router |

Contents