Administering Aginity Team

Installing Aginity Team

Installing team consists of accessing and setting up an environment based on an Ubuntu O/S. You can either do this on an existing Ubuntu Server or set up a Virtual Machine that will host the shared catalog database and Team application server.

If you have not yet done so download the software from here.

Once you register and download the software you can begin the installation process. Upon registration you the software will automatically download. The software should be titled aginity-team-<version#>-amd64.deb.

Pre-Requisites and Getting to a Server

Team is installed on an Ubuntu Server or Virtual Machine environment. The machine Ubuntu is installed on must meet the following requirements

  1. Cloud, data center or on-premises
  2. Minimum 200 GB of disk workspace
  3. 4 CPU x 16GB RAM
  4. Running Ubuntu 18.04.2 LTS (Bionic Beaver)
  5. Must have network access to databases being connected to
  6. HTTPS certificate (company provided or self-signed)

Desktop requirements

  1. Chrome browser
  2. HTTPS access to the Team Server

Note

If you are trying to install an evaluation of Aginity Team or just getting started there are several options for accessing a server environment in which to install Aginity Team server.

  1. You can ask your IT representative who is responsible for server infrastructure if there is a Ubuntu Linux server or VM available to use.
  2. You can install it locally for trial purposes using personal VMWare such as Parallels or an open source equivalent like Oracle VirtualBox.

If you would prefer, we are happy to schedule a free install for you. Please click on the link below to schedule that install.

Click here to schedule an install with an Aginity Consultant

The Installation Process

The following steps should be executed in order

Step 1: SSH into the Ubuntu server as root or you can also sudo to root once in with another that has administrative rights.

Note

In our case for documentation we are working with a Parallels Ubuntu 18.04 VM and have an account called Parallels.

ssh <username>@<ip_address>

Step 2: SFTP the aginity-team-<version#>-amd64.deb file to the logged in users home directory. Below is a sample command to do that.

sftp <username>@<ip_address>
put aginity-team-<version#>-amd64.deb
exit

Step 3: Running the install

Issue the following command to initiate the install.

sudo dpkg -i aginity-team-<version#>-amd64.deb

This image below is what you should see after the install is complete.

Post Install

Note

We will generate an encryption key to ensure all information for connections and your catalog are encrypted. The installation will automatically generate and store that key on the /etc/aginity-team/service.conf file.

Step 4: Installing SSL certificate

The SSL certificate generation can be called using

# this will generate certificate
sudo /opt/aginity-team/bin/ssl-certificate-gen.sh

You will be asked for the following information

  1. First and last name
  2. Name of organization unit
  3. Name of organization
  4. Name of City or Locality
  5. Name of State or Province
  6. Name of Country code
  7. Finally when asked to “Enter key password for <aginity_cert> (RETURN if same as keystore password): ” press RETURN

Starting Aginity Team Server

Step 5: You are now ready to start Aginity Team

We use the following commands to start Aginity Team in the background and with logging turned on.

systemctl start aginity-team

You can check if Aginity Team is running by issuing this command

sudo systemctl status aginity-team

Accessing Aginity Team for the First Time

Step 6: Step 6: Open browser and navigate to https://<ip or team server name>:8080/login. You will see the following image

Opening Amp
  • Enter credentials admin / AginityTE@M the first time to enter the application.

Step 7: Register and Apply License Key

When you open the application it will ask you to register the software and then you will be asked to apply the license key.

Opening Amp

If it does not ask for the license key you can click on Help -> Register again and the license key box should pop open as shown below.

Opening Amp

Note

It is imperative that all users be created with valid business email addresses.

Send the link to team to any new user along with their username/password combination.

Stopping Aginity Team Services

Log in as the team user and issue the following command

sudo systemctl stop aginity-team
# check to see if it is stopped Using
sudo systemctl status aginity-team

See also

Add Connections

Upgrading Aginity Team

Upgrading team consists of logging into the Team server, downloading the latest update and applying it from the command line.

For clarities sake when we refer to aginity-team-<version#>-amd64.deb we purposely leave version# generic. Each upgrade will have a different number associated with it.

Warning

It is important to take a backup of both your encryption key for the Team catalog and to do a Backing Up or Restoring Team Catalog before upgrading. This way if anything goes wrong you will not use your catalog. It is also recommended to do a manual export of your catalog from time to time.

You can get the encryption key using the command below.

sudo cat /etc/aginity-team/service.conf

Step 1: Logging into Team Server

SSH into the Team server as an administrator.

Note

Typically you will log in as an account other than root and then you will be using the sudo command

Step 2: Check to see if Team is Currently Running and then Shut it Down

Issue the command below to check the status of the Team service

sudo systemctl status aginity-team

If Team is running shut it down by issuing this command

sudo systemctl stop aginity-team

Note

It is always a good idea to run the status check again to make sure Team has been shut down.

Step 3: Download the Latest Version of Aginity Team

Using the wget command you can download the latest version as shown below.

wget http://repository.aginity.com.s3.amazonaws.com/AginityTeam/aginity-team-<version#>-amd64.deb

Step 4: Upgrading the Software

Run the upgrade process by issuing this command.

sudo dpkg -i aginity-team

When presented with the menu shown in the image below hit “N” to tell the software to keep the catalog as is.

Post Install

Step 5: Restart Aginity Team

Restart the server by issuing this command.

sudo systemctl start aginity-team

Backing Up or Restoring Team Catalog

We have provided two files listed and described below which will allow you to automate or manually backup and restore your Aginity Team catalog.

Backup Script

The backup script backup.sh will perform and compress a backup of the Aginity Team Catalog to the /tmp/ directory on your O/S. It will append the date to the end of the file created and should be named in this pattern. aginity_backup_%m_%d_%Y.zip

Note

Before running the backup.sh script you will need to edit it and provide the following variables.

  • DESTINATION ~ if you do not want to use the default /tmp/

  • TOKEN ~ this value is the encryption key for the database. To find out the value of it run this command.

    sudo cat /etc/aginity-team/service.conf
    
  • H2PATH ~ Unless you modified the installation directory from the default you should not need to change this.

  • DBPATH ~ Unless you modified the installation directory from the default you should not need to change this.

When running a backup the Aginity Team server process will be stopped then restarted when complete.

See also

If you want to schedule the backup and automate it we recommend scheduling using Crontab: Crontab Reference Guide

Restore Script

To restore to an instance of the backup follow these instructions.

You’ll need to set the variables within the restore.sh to match what is in the backup.sh.

First download the restore script restore.sh. Next you will provide the file name of the backup you want to restore in the

  • SOURCE variable.

Now run the script and it will automatically re-start Aginity Team when complete.