Cisco Elastic Services Controller 2.2 Install and Upgrade Guide

Installation Scenarios

The following sections briefly describe some of the common deployment scenarios that are addressed by ESC.

Cisco Elastic Services Controller can be installed in different modes as per the requirement. These different modes are configured during installation. The following sections briefly describe some of the common deployment scenarios that are addressed by ESC.

ESC Standalone

In the standalone scenario, a single active VM is deployed for ESC.

ESC with HA

ESC supports High Availability (HA) in the form of a Primary and Standby model. Two ESC instances are deployed in the network to prevent ESC failure and provide uninterrupted ESC service. If the primary ESC instance fails, the standby instance automatically takes over the ESC services. ESC HA resolves the following single point failures of ESC:

Network failures
Power failures
Dead VM instance
Scheduled downtime
Hardware issues
Internal application failures

For more information on deploying ESC HA, see 'Configuring High-Availability' in Installing ESC on OpenStack and Installing ESC on VMware chapters.

Main Components of Cisco Elastic Services Controller Setup

The Cisco Elastic Service Controller (ESC) setup has the following components:

Virtual Infrastructure Manager—Elastic Services Controller (ESC) and its VNFs are deployed in a Virtual Infrastructure Manager (VIM). This might have one or more underlying physical nodes.
ESC Virtual Machine—The ESC VM is a VM that contains all the services and processes used to register and deploy services. This includes the ESC Manager and all other services. ESC provides Netconf API, REST API, and Portal as north bound interfaces to communicate with ESC. ESC VM contains CLI to interact with ESC VM. There are two CLI one uses the REST API and the other uses Netconf API.

Installing Cisco Elastic Services Controller Using the QCOW Image

This procedure describes how to create ESC Virtual Machine (VM) in OpenStack.

Before You Begin

All system requirements are met as specified in Installation Requirements.
You have the information identified in Preparing for Installation.
Copy the ESC image file on the system accessible by the OpenStack on which you want to install ESC.

Step 1

Log in to the system accessible by the OpenStack on which you want to install ESC.

Step 2

Check the compatibility of the bootvm.py and the ESC image:

./bootvm.py --version

For more information on the ESC installer arguments, see Appendix: A Cisco Elastic Services Controller Installer Arguments.

Step 3

Note

To set the required environment variables for the OpenStack command-line clients, you must create an environment file called an OpenStack rc file, or openrc.sh file. This project-specific environment file contains the credentials that all OpenStack services use. The ESC installation script requires these OpenStack environment parameters to perform authentication and installation on OpenStack.

In a text editor, create a file named PROJECT-openrc.sh file and add the following authentication information. The following example shows the information for a project called admin, where the OS username is also admin, and the identity host is located at controller node.

export OS_NO_CACHE=true
export OS_TENANT_NAME= admin
export OS_USERNAME= admin
export OS_PASSWORD=admin_pass
export OS_AUTH_URL=http://controller node:35357/v2.0

Step 4

On any shell from which you want to run OpenStack commands, source the PROJECT-openrc.sh file for the respective project. In this example, you source the admin-openrc.sh file for the admin project .

$ source admin-openrc.sh

Step 5

Check the environment variables.

$ env | grep OS_

Step 6

Register ESC image file in the OpenStack image using the glance command:

$ glance image-create 
--name <image_name>
--is-public = <true or false> 
--disk-format  <disk_format> 
--container-format <container_format> 
--file <file> 
--progress

An example configuration is shown below:

$  glance image-create 
--name esc-1_0_01_11_2011-01-01
--is-public = <true or false> 
--disk-format qcow2 
--container-format bare 
--file esc-1_0_01_11_2011-01-01.qcow2
--progress

The glance image-create command is used to create a new image. The command takes the following arguments:

Note

In case of OpenStack Liberty release, 'is-public' argument cannot be used.

Arguments	Description
name	Name of the image.
is-public	(Optional) Makes the image accessible to the public.
disk-format	Disk format of the image. ESC uses a qcow2 disk format.
container-format	Container format of image. ESC uses a bare container format.
file	Local file that contains disk image to be uploaded during creation.
progress	(Optional) Shows upload progress bar.

To verify whether the image has been registered successfully:

Using OpenStack Controller:
- Log into OpenStack using your credentials.
- Navigate to Admin > Image.
  
  Verify if the image appears in the list.
Using nova CLI:
```
$ nova image-show <image_name>
```

Step 7

The standard resource requirement of ESC is 4vCPU, 8G RAM, and 30GB disk space. ESC installation script takes the pre-defined "m1.large" flavor which has the definition of 4vCPU, 8G RAM and 80G disc space. To use 30GB disk space, create a flavor with the minimum disk space requirement.

$ nova flavor-create ESC_FLAVOR_NAME ESC_FLAVOR_ID 8192 30 4

Step 8

To deploy ESC VM, do the following:

Ensure that the existing network have connectivity to OpenStack controller. To verify the network connectivity using the nova CLI use:
```
$ nova net-list
```
Record the ID of the network that ESC connects to and boot the ESC VM by using the following command:
```
./bootvm.py <esc_vm_name> --image <image_name> --net <network> --flavor <flavor_name>
```
This creates an ESC instance with the name esc_vm_name. It is connected to the network with DHCP and uses the image image_name. For more information on the ESC installer arguments, see Appendix A: Cisco Elastic Services Controller Installer Arguments.
To check the details of ESC VM and get the information including the IP address of the ESC VM, use the following command:
```
$ nova show <esc_vm_name>
```

Additional Installation Options

Deploying ESC in DHCP mode: If you use the bootvm.py argument without --ip address, then the ESC instance will be deployed in a DHCP mode. To deploy ESC in a DHCP network, use the following configuration:

./bootvm.py <esc_vm_name> --image <image_name> --net <network> --flavor <flavor_name>

Note

By default, ESC only support DHCP in IPv4 networks. If IPv6 is used, you need to log in the ESC VM and run "dhclient -6 ethX" (ethX is the V6 interface name) manually to enable V6 DHCP.

Assigning Floating IP to the ESC: If you want to associate a floating IP with the ESC instance , do the following:
1. Check for an available floating IP address and assign it to the ESC VM:
```
$ nova floating-ip-list 
$ nova floating-ip-associate esc_vm_name <ip_address>
```
2. Or create a new floating IP address and assign it to the ESC VM:
```
$ nova floating-ip-create external-net
$ nova floating-ip-associate esc_vm_name <ip_address>
```
Deploying ESC with static IPs: To use ESC in a specific network with static IPs, for example, 192.168.0.112 at esc-net1, specify --ipaddr and --gateway_ip to the bootvm command line , as shown below:

Note

Before assigning static IP, make sure the static IP is available and is not being used other machine.
```
./bootvm.py <esc_vm_name> --image <image_id> --net <network> 
--ipaddr <ip_address> --gateway_ip <default_gateway_ip_address>
```
Deploying ESC with multiple network interfaces: To use multiple networks for ESC, for example, 192.168.0.112 at esc-net1 and 10.20.0.112 at esc-net2, specify both the IP addresses and the network names of the interfaces in the --net and --ipaddr arguments in the following command line. In addition, also choose the default gateway for ESC from the gateways of these networks. Specify the default gateway for ESC through the --gateway_ip argument.
```
./bootvm.py <esc_vm_name> --image <image_id> --net <network1> 
<network2>  --ipaddr <ip_address1> <ip_address2> --gateway_ip <default_gateway_ip_address>
```
Note

If --flavor is not specified, bootvm.py will use the default flavor "m1.large" in OpenStack.
Deploy ESC with log forwarding options: To forward ESC logs to an rsyslog server, specify the IP address of the rsyslog server while creating an ESC VM. Optionally, you can also specify the port and protocol to use.
For example, if the IP address of the rsyslog server is 10.85.77.94, the port on the server to forward logs is 514, and the protocol used is UDP, the ESC installation could be
```
./bootvm.py <esc_vm_name> --image <image_id> --net esc-net1 --rsyslog_server 10.85.77.94 
--rsyslog_server_port 514 --rsyslog_server_protocol udp
```
Disabling the ESC GUI: To boot up ESC VM with the graphical user interface disabled, modify the highlighted argument, shown in the command line below:
```
./bootvm.py <esc_vm_name> --image <image_id> --net <network> 
--esc_ui_startup=False
```
Enabling REST interface for ESC: To activate the REST interface in a secure manner, use https in the following command line:
```
./bootvm.py <esc_vm_name> --image <image_id> --net <network> 
--enable-https-rest
```

Deploying ESC with global parameters: To set the global configurations through the esc_params_file during the installation, use the arguments as shown below. These global configurations can also be changed through REST API after the installation.

Note

The default security group is applied to the tenant during tenant creation. By default, the ESC configuration parameter for the security group, openstack.DEFAULT_SECURITY_GROUP_TO_TENANT is set to true. The configuration parameter must be set at the time of installation. You can query or update the parameter on ESC VM through the REST API. If the parameter is set to true, you can create and assign default security group during tenant creation. If the parameter is set to false, you cannot create or assign default security group during tenant creation. For details on the parameters that can be configured through esc_params_file, see Appendix A: Cisco Elastic Services Controller Installer Arguments.

./bootvm.py <esc_vm_name> --image <image_id> --net <network>  --flavor <flavor_name> 
--user_pass <username>:<password>:<public key file> --esc_params_file <esc parameter configuration file>

Deploying two instances of ESC to build an ESC HA pair: For more information on deploying ESC HA, see Configuring High-Availability in Installing ESC on OpenStack and Installing ESC on VMware chapters.

Changing the admin password on an ESC VM : To change the admin password for better security, do the following:

$ /opt/cisco/esc/confd/bin/confd_cli  -u admin
$ configure
$ set aaa authentication users user admin password ESC3st!234 (ESC3st!234 this is the new password)
$ commit

Before You Begin

An instance of ESC VM is up and running.

Book Title

Chapter Title

Results

Chapter: Installing Cisco Elastic Services Controller on OpenStack

Installing Cisco Elastic Services Controller on OpenStack

Installation Scenarios

ESC Standalone

ESC with HA

Main Components of Cisco Elastic Services Controller Setup

Installing Cisco Elastic Services Controller Using the QCOW Image

Additional Installation Options

Was this Document Helpful?

Contact Cisco

Related Cisco Community Discussions