Install the ESP
Server,
SAP Sybase Event Stream Processor Studio,
Sybase Control Center for SAP Sybase Event Stream Processor, and any combination of external and enterprise adapters on various
machines within your network.
Prerequisites
Ensure that you have root privileges. Before running
the installer, create a distinct group and user for
ESP, and ensure that the
user only belongs to this group. Do not install
ESP as root.
To install the SAP Sybase Event Stream Processor Plugin for
SAP HANA Studio, you must have installed
SAP HANA Studio, version 1.0.60, build id 201306271550
379371, or later.
Task
The following instructions provide a basic work flow based on selecting most of the
available options, including the ESP Server. Therefore,
some of the steps outlined here may not be applicable to your custom installation.
- Run the installer file, setup.bin. On the Introduction screen,
click Next.
- Select an installation folder. Change the default folder by typing the filepath to
the desired folder or by clicking Choose and selecting a
folder. When finished, click Next.
If the selected folder does not exist, click Yes when prompted to create the folder. If the folder
already exists, you receive a warning that any software in the folder will be
replaced. Click Next to proceed with the
installation in the existing folder.
- Choose the Custom install set. Click
Next.
The installer displays a list of components, with the check boxes for
components that are included in a typical installation checked.
- Select any additional components you want to install.
For example, if you have SAP HANA installed on your
system and want to use the ESP Studio from the
SAP HANA Studio, check the box next to
SAP Sybase Event Stream Processor Plug-in for SAP HANA
Studio.
- Clear the check boxes for any components you do not want to install.
For example, if the target installation machine hosts other
SAP products, you may have already installed the
SySAM License Utilities.
- Click Next.
If you previously selected external adapters only (no enterprise
adapters,
ESP Studio, or
ESP Server), the installer summarizes your
installation preferences and prompts you to install. Click Install to complete the installation. Otherwise,
continue.
- Select to install either a licensed copy or an evaluation
version.
Note: If you install the evaluation version, the software
will be active for a 30-day grace period, after which you are prompted for a valid
license key. During this grace period, there is no restriction on the number of cores
ESP can use. Proceed to step
11.
- If you are installing a licensed version, select one of these options:
Specify License Keys, Use Previously Deployed License Server, or Continue Installation Without a License Key.
License Type |
Process |
Specify License Keys |
- Enter the license key manually or browse for and load a license key.
- Click Next.
If you are using a served license and receive an error that the installer detects a SySAM server already
running on your machine, click Previous to return to the SySAM License Entry panel
and select the Previously Deployed License Server option.
If the license server file is not found, you receive a warning message indicating that the installer cannot verify a license server running on the selected host, and prompting you to reenter the host name and port number you provided. If the installer cannot verify the license server, select a different licensing option to continue with the installation.
|
Previously Deployed License Server |
Enter the host name and
port number or IP address. If the license server file is not found, you receive a warning message indicating that the installer cannot verify a license server running on the selected host. Reenter the host name and port number. If the installer cannot verify the license server, select a different licensing option to continue with the installation.
|
Continue Without a License Key |
If you continue without a license, the software
will be active for a 30-day grace period, after which you are prompted for a valid
license key. During this grace period, there is no restriction on the number of cores
ESP can use.
|
- From the drop-down list, select the type of product license you want to configure and click Next.
- Select Yes or No to indicate whether you want to configure e-mail
alerts about SySAM events that may require an administrator's attention.
If you select Yes, enter
the SMTP server host name, SMTP server port number, sender e-mail address, recipient
e-mail address, and message severity, or accept the defaults. Click Next.
Note:
To change the SySAM alert settings after installation, edit
these lines in the
ESP_HOME/sysam/esp_license.prop file:
- email.smtp.host=smtp
- email.smtp.port=25
- email.sender=sender@domain.com
- email.recipients=user@domain.com
- email.severity=INFORMATIONAL
Setting email.severity to
NONE disables e-mail alerts, causing all other lines to be ignored. To enable
e-mail alerts, set email.severity with
ERROR, WARNING, or INFORMATIONAL. Replace SMTP with your SMTP host name,
25 with the port number of your SMTP mail
server, sender@domain.com with your e-mail
address, and user@domain.com with e-mail
recipients. Separate multiple e-mail recipients with a comma (,).
- Use the drop-down list to select your geographic location and to
view the corresponding End-User License Agreement. Accept the terms and conditions to
continue. Click Next.
Note: If you are installing enterprise adapters only, repeat steps
7 through
11 for each enterprise adapter you are
installing. Then proceed to step
17.
- Configure cluster information:
- Create a name for your new cluster, or enter the name of an existing cluster.
- Create a name for the new node. If the node will be part of an existing multi-node cluster, all nodes names in the cluster must be unique.
- Enter the cache port for the node. The cluster cache is an internal cache for sharing cluster state and configuration information. It is for internal use only.
- By default, the installer sets the actual host name of the machine hosting this
cluster node. If it cannot determine the actual host name, it sets "localhost"
as the default value. Use the default "localhost" name only if this is a single
node cluster that will only be accessed from within the machine you are
installing on.
- Enter the RPC port for the cluster node. The
Studio, SDKs, and various other product tools, use this port to access
the cluster.
- (Optional) If you want to specify a separate admin port, change the port
number from the default. Doing so allows you to distinguish between
administrative and non-administrative users, and limit network access to
specific administrative actions, which may be advantageous when you have
firewalls in place.
- Indicate whether the RPC port supports connections through Secure Sockets Layer
(SSL). When you enable SSL, connections to the cluster use HTTPS rather than
HTTP. If you are creating a new cluster, you can decide whether you want to use
SSL or not. If you are connecting to an existing cluster, ensure this selection
matches the configuration of the existing cluster.
Note: If you disable SSL
during installation, the installer disables SSL at the cluster level, but
not at the project level. As a result, only certain
ESP client utilities, such as
esp_cluster_admin, are able to connect to the server until you disable SSL
at the project level. To do this, comment out all of the lines containing
references to either "ssl-key-file" or
"ssl-key-file-encrypted" in the
node1.xml cluster configuration file. Then, restart
the cluster. Note that this issue does not apply to Studio's
localnode.xml file.
- Click Next.
Note: After installation, you can modify your Event Stream Processor
environment to add nodes and clusters, change authentication types, and so on. For
information, see the Configuration and Administration
Guide.
- Indicate whether you want to specify a password for the cluster now or when you
start the cluster. All nodes within a cluster have the same cluster password. To set
a password now, select Yes, then enter the
password. Your password must be at least six characters long. If you are connecting
to an existing cluster, use the password defined for that cluster.
- Configure security for the cluster, then click Next. If you are connecting to an existing cluster, select the security type the existing cluster uses, and provide credentials for that cluster:
Authentication Type |
Description |
Native OS |
Provides authentication based on your operating system. Choose this
authentication type if you wish to use the same credentials that you use to log
in to your machine. |
SAP BI |
Provides SAP BI authentication. Choose this authentication type if you
wish your SAP BI instance to handle authentication. |
LDAP |
Provides LDAP authentication. Enter the following information as indicated
by your LDAP implementation:- Server type
- Provider URL
- Default search base
- Authentication scope
|
Kerberos |
Provides Kerberos authentication. Enter the following information as
indicated by your Kerberos implementation:- Realm
- KDC
- Service Principal Name
- Keytab Location
Note: If you do not set these values during installation, you can set them
post-installation. See Configuration and Administration Guide >
Get Started with a Cluster > Configuring Security > Authentication
> Configuring Kerberos Authentication.
|
RSA |
Provides RSA authentication. |
- Set the keystore properties for the cluster. These keys encrypt/decrypt data
within Event Stream Processor, such as passwords required to read
or write to databases. If you are connecting to an existing cluster, use the keystore
properties already defined for that cluster:
- Indicate the location of the keystore file.
Event Stream Processor needs access to the keystore for
encryption/decryption.
- Select Yes or No to indicate whether you want to enter a password to access the keystore file and key. If you select No, you are prompted for the password at startup.
- (Optional) Enter and confirm the password for the keystore. Your password must
be at least six characters long.
- Click Next.
- If you are installing the Web Services (SOAP) adapter, select
Yes or No to indicate whether you want to enable the ESP Web Services Provider. If you select
Yes, configure the ESP Web Services Provider:
- Specify a value for the SOAP port of the SOAP server to
which the provider connects, or accept the default value.
- Specify values for the HTTP and HTTPS ports, or accept the
default values. Click Next.
If you select No,
the default values are accepted and the ESP Web Services Provider server does not
start.
- Select a workspace folder to store projects. Change the default
folder by typing the filepath to the desired folder or by clicking Choose and selecting a folder. When finished, click
Next.
If you are installing enterprise adapters, repeat steps
7 through
11 for each adapter.
- If you are installing the SAP Sybase Event Stream Processor Plug-in for
SAP HANA Studio, specify the parent folder of the
SAP HANA Studio directory
(hdbstudio). For example, if your installation path is
/usr/sap/hdbstudio, specify /usr/sap. Click Next.
- Review installation information before continuing. Click Previous to go back and make changes. Click Install to proceed with the installation.
- If you are installing Sybase Control Center for
Event Stream Processor:
- If you did not install the ESP Server during this
installation, specify the authentication type
ESP is using. If you did install the
server with this installation, you have already provided this information
and the installer does not prompt you to provide it again.
- Specify values for the HTTP and HTTPS ports for Sybase Control Center that do not conflict with ports used by
other applications and services on the system, or accept the default
values.
- Specify a value for the RMI port for the RMI service that is not used by
other applications and services on the system, or accept the default
value.
- Enter and confirm a password for the SCC
administrator. Minimum length is six characters.
This password is encrypted and written to the
SCC
csi.properties file.
- If installing the SCC agent, enter and
confirm a password for the SCC agent administrator.
- Select Yes or No to indicate whether you want to start the
Sybase Control Center service.
- A message indicates Event Stream Processor
was successfully installed into the location of your choice, and to restart the system to complete the
installation. Click Done to quit the
installer.