Installation Manual¶

Installation summary¶

You can find general information, technical description and deployment considerations about Excalibur components in deployment documentation.

Excalibur Enterprise installation process:

1. Excalibur Server installation (required)
2. Excalibur Facade installation (required)
3. Excalibur Dashboard administrator registration (required)
4. Excalibur Client(s) registration (optional)
5. Excalibur TRESK installation (optional)

Content of deployment package¶

• excalibur-<customer>-<version>.zip*

  • Server - installation files for Excalibur Server component

  • Facade - installation binaries for Excalibur Facade component

    • excalibur-ad-facade-<version>-x64-<customer>-<type>.msi

  • Client - installation binaries for Excalibur Client component

    • excalibur-client-<version>-x86-<customer>-<type>.msi
    • excalibur-client-<version>-x64-<customer>-<type>.msi

Excalibur Server installation¶

Requirements¶

• Single-node deployment - consists of one node with full service stack.

• High Availability deployment - consists of a cluster of at least 3 nodes. Where a pair of nodes (primary, secondary) take over the role of execution and control nodes, the other node (arbiter) is used only for the management of the swarm services.

Installation package content¶

• config/ - directory with application configuration/customization
  • certificates
    • push - push messages certificates/keys
    • ssl - placeholder directory for TLS certificates
    • xclbr - certificates for Excalibur components
  • conf.d - granulated main configuration (optional)
  • excalibur.json - server`s main configuration file
  • logger.json - server`s logger configuration file
  • mongodb.json - storage service configuration
  • db_root_password - root/failover password for database(s)
  • logo.png - company logo
  • push.yml - push messages (gorush) configuration file
• excalibur.sh - main installation and maintenance script
• excalibur-stack.yml - Excalibur Server service definition
• excalibur-stack-ha.yml - HA extra stack configuration (HA variant)
• excalibur-stack-logging.yml - Syslog/Siem logging extra options (optional)

Installation with two phases¶

• First phase (-o) consist of Docker swarm initialization and appropriate certificate generation, but no docker deploy is done.

  ./excalibur.sh install -o -r primary
  

• After that phase there is a space for (TLS) certification fine-tuning. You can swap temporary/self-signed one's (automatically generated during first phase) with ones issued by real CA. To completely finish installation run main scrip again but now with update action.

  ./excalibur.sh update -r
  

Installation steps - single node variant¶

Copy the installation package to the server and unpackage it. Precondition for all installation steps is that your working directory/path is set to directory where you unpack deployment package.

1. Generate application certificates and create local Docker swarm:

   ./excalibur.sh install -o
   

   Note

   After this step, certs/ directory is created which contains all certificates and cryptography files.

2. Update TLS/SSL (Dashboard) certificate and private key. (recomended)

   cp new_dashboard.crt ./certs/dashboard.crt
   cp new_dashboard.key ./certs/dashboard.key
   

   Note

   This step is optional but highly recommended. If you decide to do it later, than follow appropriate steps from Administration manual.

3. Adjust main (server) configuration. (optional)

   vim ./config/excalibur.json
   

   Note

   You can find full description of configuration options in Administration manual.

4. Deploy (updated) stack configuration into local Docker Swarm:

   ./excalibur.sh update -l
   

5. Check system status

   ./excalibur.sh status
   

6. Follow server`s post installation steps

Installation steps - HA variant¶

Copy the installation package to all nodes on same path and unpackage it. Precondition for all installation steps is that your working directory/path is set to directory where you unpack deployment package.

1. System installation steps on primary node - node #1

   1. Generate application certificates and create Docker swarm:

      ./excalibur.sh install -sor primary
      

      Note

      During installation you must provide ip address of node #1 node! Script generates swarm join token for installation on other HA nodes.

   2. Update TLS certs. (recomended)

      Note

      This step is optional but highly recommended. If you decide to do it later, than follow appropriate steps from Administration manual.

   3. Deploy (updated) stack configuration into Docker Swarm:

      ./excalibur.sh update -lsr
      

2. System installation steps on secondary node - node #2

   1. Join node into already created swarm as secondary role:

      ./excalibur.sh install -sr secondary
      

      Note

      During installation you must provide ip address of node #1 (primary) node and swarm join token!

3. System installation steps on arbiter node - node #3

   1. Join node into already created swarm as arbiter role:

      ./excalibur.sh install -sr arbiter
      

      Note

      During installation you must provide ip address of node #1 (primary) node and swarm join token!

4. Database replication steps on secondary node - node #2

   1. Dump database from primary node

      ./excalibur.sh ha db -D
      

   2. Clear excalibur database on secondary node

      ./excalibur.sh ha db -C
      

   3. Apply database dump from primary node

      ./excalibur.sh ha db -A
      

5. Database replication steps on primary node - node #1

   1. Enable database master-master replication

      ./excalibur.sh ha db -e
      

   2. Check MariaDB replication status

      # show master status
      ./excalibur.sh ha db -m
      
      # show secondary status
      ./excalibur.sh ha db -s
      

6. Recordings storage replication steps on primary node - node #1

   1. Enable recordings storage master-master replication

      ./excalibur.sh ha mongo -r
      

   2. Check MongoDB replication status

      ./excalibur.sh ha mongo -s
      

7. Follow server`s post installation steps

Post-installation steps¶

1. Excalibur Facade component installation

2. Very first administrator registration

   1. Load the Excalibur Dashboard on the browser
   2. Fill Active Directory username and administrator password to the shown registration form
   3. Install the mobile app to the administrator's phone Excalibur User Manual.
   4. Scan the schown registration QR from the Excalibur Dasboard screen and finish the registration

   Warning

   The registered administrator is automatically the Excalibur system administrator with the highest rights in the Dashboard console.

3. Excalibur Client component installation

Additional configuration options¶

If Docker operates behind proxy update docker service file located at /lib/systemd/system/docker.service and restart docker service.

[Service]
  Environment="HTTPS_PROXY=https://proxy.example.com:443/"
  Environment="NO_PROXY=docker-registry.local"
  .
  .
  .

systemctl restart docker.service

Optional logging - rsyslogd configuration

cat << EOF > /etc/rsyslog.d/excalibur-logger.conf
# provides UDP syslog reception
module(load="imudp")
input(type="imudp" port="514")

# provides TCP syslog reception
module(load="imtcp")
input(type="imtcp" port="514")

if( re_match( $syslogtag, 'excalibur-(proxy|db-primary|db-secondary|mongodb-primary|mongodb-secondary|mongodb-arbiter)') ) then {
  # write to file
  action(type="omfile" file="/var/log/excalibur-system.log")
  stop
}

if( $syslogtag startsWith 'excalibur') then {
  # write to file
  action(type="omfile" file="/var/log/excalibur.log")
  stop
}
EOF

systemctl restart rsylog.service

To store Recordings on custom host location please update volume section in excalibur-stack.yml file.

volumes:
  exc-mongodb-data:
    driver: local
    driver_opts:
      type: none
      o: bind
      device: /my-custom-location

Excalibur Server uninstall¶

Uninstall - single node variant¶

1. Uninstall application files, remove application stack and leave Docker Swarm:

   ./excalibur.sh uninstall
   

Uninstall - HA variant¶

1. Uninstall steps on primary node - node #3

   1. Uninstall application files on arbiter node and leave Docker Swarm:

      ./excalibur.sh uninstall
      

2. Uninstall steps on primary node - node #2

   1. Uninstall application files on secondary node and leave Docker Swarm:

      ./excalibur.sh uninstall
      

3. Uninstall steps on primary node - node #1

   1. Uninstall application files on primary node, remove application stack and leave Docker Swarm:

      ./excalibur.sh uninstall
      

Uninstall - manual cleanup (In case of automatic uninstall failure)¶

• Uninstall steps are same for all nodes and instalation types

  1. Leave Docker Swarm:

     docker swarm leave --force
     

  2. Clean all volumes, containers, images and networks

     docker system prune --all --volumes --force
     

  3. Remove remaining persistent storage data or instalation specific files manually from the host file system

Excalibur Facade component installation¶

Requirements¶

Installation steps (gMSA account)¶

1. Install gMSA to the computer, which is domain controller.
2. Install AD modul for Windows PowerShell.
3. Create a gMSA account on AD.
4. Assign the appropriate rights to the created account AD Facade Manual.
5. Configure created account to the target computer (AD).
6. Install delivered installation package to the AD domain controller.

Excalibur Client component installation¶

Requirements¶

Installation steps¶

1. Run the supplied msi installation package
2. Follow the instructions of the installation program
3. Start using Excalibur Client after logout current session.

Excalibur TRESK component installation¶

Overview¶

Requirements¶

Installation steps¶

1. Generate run script
2. Execute run script on TRESK-VM
3. ...

Further materials¶

Excalibur User Manual

Excalibur Administrattor Dashboard Manual

Excalibur Client Installation Manua

Excalibur AD Facade manual

Excalibur Whitepaper

Excalibur Tresk Whitepaper