Install Edge components on a node

Edge for Private Cloud v. 4.17.09

After you install the Edge apigee-setup utility on a node, use the apigee-setup utility to install one or more Edge components on the node.

The apigee-setup utility uses a command in the form:

> /opt/apigee/apigee-setup/bin/setup.sh -p component -f configFile

where component is the Edge component to install, and configFile is the silent configuration file containing the installation information. The configuration file must be accessible or readable by the "apigee" user. For example, you can create a new directory for the files, place them in the /usr/local or /usr/local/share directory, or anywhere else on the node accessible by the "apigee" user.

For example, to install the Edge Management Server:

> /opt/apigee/apigee-setup/bin/setup.sh -p ms -f /usr/local/myConfig

Installation considerations

As you write your config file, take into consideration the following options.

Setting up Postgres master-standby replication

By default, Edge installs all Postgres nodes in master mode. However, in production systems with multiple Postgres nodes, you must configure them to use master-standby replication so that if the master node fails, the standby node can continue to serve traffic.

You can enable and configure master-standby replication at install time by using properties in the silent config file. Or, you can enable master-standby replication after installation. For more, see Set up Master-Standby Replication for Postgres.

Enabling Cassandra authentication

By default, Cassandra installs without authentication enabled. That means anyone can access Cassandra. You can enable authentication after installing Edge, or as part of the installation process.

For more, see Enable Cassandra authentication.

Using a protected port when creating a virtual host

If you want to create a virtual host that binds the Router to a protected port, such as port numbers less than 1000, then you have to configure the Router to run as a user with access to those ports. By default, the Router runs as the user "apigee" which does not have access to privileged ports.

For information about how to confgure a virtual host and Router to access ports below 1000, see Setting up a virtual host.

Specifying the components to install

The following table lists the options you pass to the -p option of the apigee-service utility to specify which components to install on the node:

Component	Description
c	Install Cassandra only.
zk	install ZooKeeper only.
ds	Install ZooKeeper and Cassandra.
ld	Install OpenLDAP only.
ms	Install Edge Management Server, which also installs the Edge UI and OpenLDAP. If you set USE_LDAP_REMOTE_HOST=y in the config file, then OpenLDAP installation is skipped and the Management Server uses OpenLDAP installed on a different node.
r	Install Edge Router only.
mp	Install Edge Message Processor only.
rmp	Install Edge Router and Message Processor.
ui	Install the Edge UI.
qs	Install Qpid Server only.
ps	Install Postgres Server only.
pdb	Install Postgres database only - used only when installing the Developer Services portal. See Developer Services portal installation.
sax	Install the analytics components, meaning Qpid and Postgres. Use this option for development and testing only, not for production.
sso	Install the Edge SSO module.
mo	Install Monetization.
sa	Install Edge standalone, meaning Cassandra, ZooKeeper, Management Server, OpenLDAP, Edge UI, Router, and Message Processor. This option omits the Edge analytics components: Qpid and Postgres. Use this option for development and testing only, not for production.
aio	Install all components on a single node. Use this option for development and testing only, not for production.
dp	Install the Developer Services portal.

Creating a configuration file

The configuration file contains all the information necessary to install Edge. You can often use the same configuration file to install all components in an Edge installation.

However, you will have to use different configuration files, or modify your configuration file, if:

You are installing multiple OpenLDAP servers and need to configure replication as part of a 13-node installation. Each file requires different values for LDAP_SID and LDAP_PEER.
You are creating multiple data centers as part of a 12-node installation. Each data center requires different settings for properties such as ZK_CLIENT_HOSTS and CASS_HOSTS.

Each installation topology described below shows an example config file for that topology. For a complete reference on the config file, see Edge Configuration File Reference.

Installation log files

By default, the setup.sh utility writes log information about the installation to:

/opt/apigee/var/log/apigee-setup/setup.log

If the user running the setup.sh utility does not have access to that directory, it writes the log to the /tmp directory as a file named setup_username.log.

If the user does not have access to /tmp, the setup.sh utility fails.

Install Edge components

This section describes how to install Edge components for the different topologies. The order of component installation is based on your desired topology.

All of the installation example shown below assume that you are installing:

With Cassandra authentication disabled (default). See Enable Cassandra authentication for more.
With Postgres master-standby replication disabled (default). See Set up Master-Standby Replication for Postgres for more.
Message Processor and Router on the same node. If you install the Message Processors and Routers on different nodes, install all the Message Processors first, and then all the Routers.