Alpaca Remote

Introduction

Alpaca Remote is a tool that transmits audit logs from their source location to the Alpaca Server for processing. Audit logs are transmitted to the Alpaca Server via REST.

Installation

Alpaca Remote should be installed on the server where your BroadWorks Audit Logs are located.

Prerequisites

Process

  1. Download the Alpaca Remote tarball(.tar.gz) to the /opt directory on the server.
  2. Extract the archive.
    • cd /opt
    • tar xzvf /opt/alpaca-remote-<BW_VERSION>-<RELEASE_VERSION>-bin.tar.gz
  3. Create a symlink to the new alpaca directory.
    • ln -s /opt/alpaca-remote-<BW_VERSION>-<RELEASE_VERSION> /opt/alpaca-remote
  4. Create an alpaca user.
    • useradd -m alpaca
  5. Change the ownership of the /opt/alpaca-remote directory and all of its children.
    • chown -R alpaca:alpaca /opt/alpaca-remote/
  6. Copy the license file from the ECG portal ecg.license.txt into the config directory.
  7. Perform configuration according to Alpaca Remote configuration guide.

Installing Alpaca Server and Alpaca Remote on separate servers

  1. Copy the alpaca file into /etc/init.d.
  2. Run the following commands:
    1. chkconfig --add alpaca
    2. chkconfig alpaca on
  3. Launch service with service alpaca start.

Installing Alpaca Server and Alpaca Remote on the same server

  1. Copy the alpaca file into /etc/init.d and rename to alpaca-remote using mv alpaca /etc.init.d/alpaca-remote.
  2. Run the following commands:
    1. chkconfig --add alpaca-remote
    2. chkconfig alpaca-remote on
  3. Launch service with service alpaca-remote start.

Configuration

One Alpaca User per cluster must be configured for Alpaca Remote to use. This user should only have credentials for the one BroadWorks cluster that we are reading logs for.

  • hostname - The hostname of the Alpaca server to send logs to.
  • port - The port that the Alpaca server is running on.
  • username - The username of the Alpaca User configured on the server.
  • password - The password of the Alpaca User configured on the server.
  • audit-log-readers - The list of directories to read from.
alpaca:
  remote:
    servers:
    - hostname: localhost
      port: 8080
      username: remote
      password:
      audit-log-readers:
      - directory: /opt/audit/lab

Usage

Once Alpaca Remote has been installed and configured, it can be ran with service alpaca start. Once launched, Alpaca Remote will transmit audit logs to the Alpaca Server.