Installing the Avaya Aura Web Gateway

Last Updated : Dec 23, 2024 |

About this task

Use this procedure to install a standalone Avaya Aura® Web Gateway or the initial node for an Avaya Aura® Web Gateway cluster.

Important:

Do not use this procedure to install additional nodes to a cluster. For more information on installing additional nodes, see Installing additional nodes to create a cluster.

Before you begin

  • Deploy the Avaya Aura® Web Gateway OVA.

  • Start the virtual machine.

  • If you are planning to use FIPS, enable it as described in Enabling FIPS mode. You cannot enable FIPS mode during or after Avaya Aura® Web Gateway installation. You cannot use the OAuth authentication feature when FIPS mode is enabled.

Procedure

  1. Open the Linux shell using your Linux administrator account credentials.

    The Linux administrator account is created during the deployment process.

  2. Do one of the following:

    • If you install Avaya Aura® Web Gateway using the OVA, run the following command:

      app install

      When you run the app install command without specifying a build, then the system automatically picks up the current build in opt/Avaya. If you do specify a build by running app install csa-<version>.bin, then the system looks for that build first in your current working directory and then in opt/Avaya.

    • If you install Avaya Aura® Web Gateway as a software-only application, run the following command:

      app install <PATH>/<INSTALLER>

      In this command, <PATH> is the full path to the directory where you extracted the application binary when installing the system layer, and <INSTALLER> is the Avaya Aura® Web Gateway application binary. For example:

      app install /root/csa-swonly-10.1.0.0/csa-10.1.0.0.bin

    The system displays the installation screen.

    Important:

    During the installation, do not resize the screen or the SSH console.

  3. If you are installing the initial node for a new cluster, then do the following:
    1. Select Cluster Configuration.
    2. Ensure that Initial cluster node is set to y (yes) and Local Node IP address is set to the IP address of the node.

      These are the default values.

      To return to the previous menu, select Return to Main Menu and press Enter.

    3. Optional In the Cassandra Encryption menu, enable SSL encryption to secure Cassandra database communications between nodes in a cluster.
      Important:

      • If you want to enable Cassandra internode encryption, you must enable it during the initial installation. This setting cannot be changed after the initial installation.

      • If you enabled FIPS mode, ensure that Cassandra internode encryption remains enabled. If you disable Cassandra internode encryption, installation will fail.

  4. Select Front-end host, System Manager and Certificate Configuration and do the following:
    1. For a standalone node, select Front-end IP or FQDN and enter the FQDN that clients use to access services.

      The default value is the FQDN assigned to the local server.

      For a cluster deployment that uses the internal load balancer, you must configure Front-end IP or FQDN as the FQDN corresponding to the virtual IP address of the internal load balancer.

      For a cluster deployment that uses an external load balancer, you must configure Front-end IP or FQDN as the FQDN corresponding to the external load balancer.

    2. Select System Manager FQDN and enter the FQDN of the Avaya Aura® System Manager that signs the certificates for Avaya Aura® Web Gateway services.
    3. Optional Select System Manager web admin username (o) and System Manager web admin password and provide the credentials.
    4. Select System Manager HTTPS Port and type the port for contacting the REST interface of Avaya Aura® System Manager.

      The default port is 443.

    5. Select System Manager Enrollment Password and type the Avaya Aura® System Manager enrollment password.
    6. Select Keystore password and type a password to use for the local keystore.
      Important:

      You must remember the Keystore password for future references. You need this password for any certificate management tasks.

    7. Configure additional settings that are required for your system as described in Front-end host, System Manager, and certificate configuration.

      To return to the previous menu, select Return to Main Menu and press Enter.

  5. Select Deployment settings and then press the Spacebar to select the deployment option that corresponds to the solution that you are installing.

    If you have conferencing in your solution, then select Team Engagement + Conferencing. Otherwise, you must select Team Engagement. Do not select Conferencing only.

  6. To review the settings, select Continue and then select Accept and continue.

    The system runs pre-install configuration checks.

  7. To install the software, select Continue and then accept the license agreement.

    Wait for several minutes while the installation proceeds.

  8. Select Continue to start the configuration utility.
    Important:

    Do not change the settings in Front-end host, System Manager and Certificate Configuration without reentering the System Manager enrollment and keystore passwords before applying the changes.

  9. Select LDAP Configuration, and then configure each of the LDAP settings using the LDAP configuration information for your network.

    For more information on LDAP configuration, see LDAP configuration.

  10. Optional If this is an initial node for a cluster, and you want to use internal load balancing, do the following:
    Important:

    • The virtual IP address is used for redundancy management of the internal load balancer in a cluster.

    • To avoid performance degradation of the cluster, an external load balancer is recommended for clusters with four or more nodes.

    • For a cluster deployment that uses an external load balancer, you must configure Front-end IP or FQDN as the FQDN corresponding to the external load balancer.

    • If you use an external load balancer, do not configure the virtual IP settings that enable the internal load balancer.

    1. Select Clustering Configuration > Virtual IP Configuration.
    2. Select Enable virtual IP and set the value to y (yes).

      The system displays additional Virtual IP configuration.

    3. Configure all of the Virtual IP settings as described in Virtual IP configuration options.

      You must configure the initial node as the Virtual IP master node. In a cluster, you must configure one additional node as the Virtual IP backup node.

      Important:

      You must save the Virtual IP authentication password. You need this password when configuring the second node in the cluster as the virtual IP backup node.

    4. To save the changes on the system, select Apply and then select Continue.
    5. Select Return to Main Menu and press Enter.
  11. To apply the changes, from the main menu, select Continue and then select Yes to start the services.

    The system starts the services.

  12. To exit the configuration tool, select Continue.

Next Steps

Related information
Unexpected characters in the /etc/hosts file on a localhost line