Commit 1b0388a2 authored by Jeffrey Schlitt's avatar Jeffrey Schlitt

added changes to make install correct

parent 22369d49
.. _teaminstall:
********************************************************
Installing the Catalog Server for |var_product_name|
********************************************************
Installing team consists of setting up a Virtual Machine that hosts the shared catalog database and Team application server. Once that is configured your administrator will provide you with a Web URL to access the Team application.
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 <https://www.aginity.com/pricing/>`_.
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-linux-<version#>-x64.tgz**.
Pre-Requisites and Getting to a Server
==========================================
Pre-Requisites
==============
Team is installed on an Ubuntu environment. The machine Ubuntu is installed on must meet the following requirements
Team is installed on an Ubuntu virtual machine we supply with the application. This machine must meet the following requirements
#. Minimum 32GB RAM
#. Minimum 10GB of space
#. Running Ubuntu 18.04.2 LTS (Bionic Beaver)
.. 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.
#. You can ask your IT representative who is responsible for server infrastructure if there is a Ubuntu Linux server or VM available to use.
#. You can install it locally for trial purposes using personal VMWare such as `Parallels <https://www.parallels.com/>`_ or an open source equivalent like `Oracle VirtualBox <https://www.virtualbox.org/>`_.
To install the Catalog Server follow the steps below.
If you would prefer, we are happy to schedule a free install for you. Please click on the link below to schedule that install.
* Install Ubuntu. `Here is link to the currently supported version. <https://releases.ubuntu.com/18.04>`_
`Click here to schedule an install with an Aginity Consultant <https://outlook.office365.com/owa/calendar/Aginity@aginity365.onmicrosoft.com/bookings/s/8FDfJOeuUUa7UehVlqSdkg2>`_
Once this is done create a service administrator account called svc_admin to own the software and to automate the starting of the services. Install the software into the svc_admin home directory.
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.
.. code-block:: bash
/home/svc_admin/aginity-team/
ssh parallels@<ip_address>
Once complete you are ready to download and install |var_product_name|
**Step 2:** Lets create a new user to run the team service from and a directory to hold the software.
* Go get `aginity-team-linux-{version}.tgz` from your Aginity technical representative. They will provide links to the Aginity repository during the Beta period.
* Uncompress the file using the following commands.
.. note:: Aginity recommends you install Aginity Team in the /opt directory on the server. This follows standard practice on where software is typically installed on Ubuntu environments.
.. code-block:: bash
tar -xvzf aginity-team-linux-{version}.tgz
sudo adduser team_svc_admin
# make directory in /opt to hold the software
sudo mkdir /opt/aginityteam
# change ownership to the team_svc_admin to administer the software directory
sudo chown team_svc_admin aginityteam
* Using a terminal in the folder you extracted zip to run this command to generate a key and then the export command to register the key. Be sure to store it somewhere safe if you ever need to re-install the software from scratch. This key is used to encrypt the metadata in the catalog database.
.. note::
.. note:: Aginity recommends you install Aginity Team in the /opt directory on the server. This follows standard practice on where software is typically installed on Ubuntu envrionments.
You can use any account or name you wish but from instead of team_svc_admin replace that with the name you chose.
**Step 3:** Let's SFTP as that new user and copy the tar file to the user directory using this set of commands
.. code-block:: bash
# this creates the key
bash bin/key-gen.sh
sftp team_svc_admin@<ip_address>
cd /opt/aginityteam
put aginity-team-linux-<version#>-x64.tgz
quit
**Step 4:** Now ssh as that user so we can install the software
.. code-block:: bash
ssh team_svc_admin@<ip_address>
cd /opt/aginityteam
# uncompress the file
tar -xvzf aginity-team-linux-<version#>-x64.tgz
**Step 5:** Generate a key to encrypt the metadata stored in the Team server repository
.. note::
Be sure to store it somewhere safe if you ever need to re-install the software from scratch. This key is used to encrypt the metadata in the catalog database.
.. code-block:: bash
cd /opt/aginityteam/bin
# this creates the key
bash key-gen.sh
# this registers the key with the software
export AGINITY_ENCRYPTION_KEY=“YOUR_KEY_GENERATED_IN_PREVIOUS_STEP”
export AGINITY_ENCRYPTION_KEY=“YOUR_KEY_GENERATED_IN_PREVIOUS_STEP”
**Step 6:** Installing SSL certificate
The SSL certificate generation can be called housing
.. code-block:: bash
cd /opt/aginityteam/bin
# this will generate certificate
bash ssl_certificate_gen.sh
You are now ready to start |var_product_name|
You will be asked for the following information
#. First and last name
#. Name of organization unit
#. Name of organization
#. Name of City or Locality
#. Name of State or Province
#. Name of Country code
#. Finally when asked to "Enter key password for <aginity_cert> (RETURN if same as keystore password): " use the default password **changeit**
Starting Aginity Team Server
================================
**Step 7:** You are now ready to start |var_product_name|
We use the following commands to start |var_product_name| in the background and with logging turned on.
.. code-block:: bash
# switch to the aginity-team service account (housing the base team folder)
sudo su - svc_admin
cd aginity-team
# invoke the startup command
nohup ./bin/team-server-start.sh > ./team-logs.out 2>&1 &
# invoke the startup command with logging
cd /opt/aginityteam/bin
nohup bash team-server-start.sh > team-logs.out 2>&1 &
If you do not want logging turned on use the following commands
.. code-block:: bash
# switch to the aginity-team service account (housing the base team folder)
sudo su - svc_admin
cd aginity-team
# invoke the startup command
nohup ./bin/team-server-start.sh >/dev/null 2>&1 &
# invoke the startup command without logging
nohup bash team-server-start.sh >/dev/null 2>&1 &
You can check if |var_product_name| is running by issuing this command
.. code-block:: bash
sudo ps aux | grep aginity-team
Installing SSL certificate
==================================
* Before running Team app one should execute the following steps:
#. Using provided distribution generate ssl certificate using bin/ssl_certificate_gen.sh
#. Proceed with command line input as required
#. Leave default password for the keystore
ps aux | grep aginity-team
Accessing |var_product_name| for the First Time
=================================================
* Open a browser and navigate to https://<ip or team server name>:8080/app, you will be redirected to https://<ip or team server name>:8080/login. You will see the following image.
**Step 8:** Open a browser and navigate to https://<ip or team server name>:8080/app, you will be redirected to https://<ip or team server name>:8080/login. You will see the following image.
.. image:: ../../team_images/team_login_screen.png
:scale: 15
:scale: 40
:align: center
:alt: Opening Amp
* Enter credentials **admin** / **AginityTE@M** - You will be redirected to https://localhost:8080/app
* The admin user will then allow you to create other individual users.
**Step 9:** 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.
.. image:: ../../team_images/team_register.png
:scale: 40
:align: center
:alt: 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.
.. image:: ../../team_images/team_license_apply.png
:scale: 40
:align: center
:alt: Opening Amp
.. note::
......@@ -121,7 +196,6 @@ Stopping |var_product_name| Services
sudo pkill -f aginity-team
Once you open |var_product_name| you will commonly do these Actions.
.. seealso::
:ref:`Add Connections <newconn>`
This diff is collapsed.
......@@ -172,8 +172,9 @@
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="docs/admin/install_team.html">Installing the Catalog Server for Aginity Team</a><ul>
<li class="toctree-l2"><a class="reference internal" href="docs/admin/install_team.html#pre-requisites">Pre-Requisites</a></li>
<li class="toctree-l2"><a class="reference internal" href="docs/admin/install_team.html#installing-ssl-certificate">Installing SSL certificate</a></li>
<li class="toctree-l2"><a class="reference internal" href="docs/admin/install_team.html#pre-requisites-and-getting-to-a-server">Pre-Requisites and Getting to a Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="docs/admin/install_team.html#the-installation-process">The Installation Process</a></li>
<li class="toctree-l2"><a class="reference internal" href="docs/admin/install_team.html#starting-aginity-team-server">Starting Aginity Team Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="docs/admin/install_team.html#accessing-var-product-name-for-the-first-time">Accessing Aginity Team for the First Time</a></li>
<li class="toctree-l2"><a class="reference internal" href="docs/admin/install_team.html#stopping-var-product-name-services">Stopping Aginity Team Services</a></li>
</ul>
......
This diff is collapsed.
.. _teaminstall:
********************************************************
Installing the Catalog Server for |var_product_name|
********************************************************
Installing team consists of setting up a Virtual Machine that hosts the shared catalog database and Team application server. Once that is configured your administrator will provide you with a Web URL to access the Team application.
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 <https://www.aginity.com/pricing/>`_.
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-linux-<version#>-x64.tgz**.
Pre-Requisites and Getting to a Server
==========================================
Pre-Requisites
==============
Team is installed on an Ubuntu environment. The machine Ubuntu is installed on must meet the following requirements
Team is installed on an Ubuntu virtual machine we supply with the application. This machine must meet the following requirements
#. Minimum 32GB RAM
#. Minimum 10GB of space
#. Running Ubuntu 18.04.2 LTS (Bionic Beaver)
.. 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.
#. You can ask your IT representative who is responsible for server infrastructure if there is a Ubuntu Linux server or VM available to use.
#. You can install it locally for trial purposes using personal VMWare such as `Parallels <https://www.parallels.com/>`_ or an open source equivalent like `Oracle VirtualBox <https://www.virtualbox.org/>`_.
To install the Catalog Server follow the steps below.
If you would prefer, we are happy to schedule a free install for you. Please click on the link below to schedule that install.
* Install Ubuntu. `Here is link to the currently supported version. <https://releases.ubuntu.com/18.04>`_
`Click here to schedule an install with an Aginity Consultant <https://outlook.office365.com/owa/calendar/Aginity@aginity365.onmicrosoft.com/bookings/s/8FDfJOeuUUa7UehVlqSdkg2>`_
Once this is done create a service administrator account called svc_admin to own the software and to automate the starting of the services. Install the software into the svc_admin home directory.
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.
.. code-block:: bash
/home/svc_admin/aginity-team/
ssh parallels@<ip_address>
Once complete you are ready to download and install |var_product_name|
**Step 2:** Lets create a new user to run the team service from and a directory to hold the software.
* Go get `aginity-team-linux-{version}.tgz` from your Aginity technical representative. They will provide links to the Aginity repository during the Beta period.
* Uncompress the file using the following commands.
.. note:: Aginity recommends you install Aginity Team in the /opt directory on the server. This follows standard practice on where software is typically installed on Ubuntu environments.
.. code-block:: bash
tar -xvzf aginity-team-linux-{version}.tgz
sudo adduser team_svc_admin
# make directory in /opt to hold the software
sudo mkdir /opt/aginityteam
# change ownership to the team_svc_admin to administer the software directory
sudo chown team_svc_admin aginityteam
* Using a terminal in the folder you extracted zip to run this command to generate a key and then the export command to register the key. Be sure to store it somewhere safe if you ever need to re-install the software from scratch. This key is used to encrypt the metadata in the catalog database.
.. note::
.. note:: Aginity recommends you install Aginity Team in the /opt directory on the server. This follows standard practice on where software is typically installed on Ubuntu envrionments.
You can use any account or name you wish but from instead of team_svc_admin replace that with the name you chose.
**Step 3:** Let's SFTP as that new user and copy the tar file to the user directory using this set of commands
.. code-block:: bash
# this creates the key
bash bin/key-gen.sh
sftp team_svc_admin@<ip_address>
cd /opt/aginityteam
put aginity-team-linux-<version#>-x64.tgz
quit
**Step 4:** Now ssh as that user so we can install the software
.. code-block:: bash
ssh team_svc_admin@<ip_address>
cd /opt/aginityteam
# uncompress the file
tar -xvzf aginity-team-linux-<version#>-x64.tgz
**Step 5:** Generate a key to encrypt the metadata stored in the Team server repository
.. note::
Be sure to store it somewhere safe if you ever need to re-install the software from scratch. This key is used to encrypt the metadata in the catalog database.
.. code-block:: bash
cd /opt/aginityteam/bin
# this creates the key
bash key-gen.sh
# this registers the key with the software
export AGINITY_ENCRYPTION_KEY=“YOUR_KEY_GENERATED_IN_PREVIOUS_STEP”
export AGINITY_ENCRYPTION_KEY=“YOUR_KEY_GENERATED_IN_PREVIOUS_STEP”
**Step 6:** Installing SSL certificate
The SSL certificate generation can be called housing
.. code-block:: bash
cd /opt/aginityteam/bin
# this will generate certificate
bash ssl_certificate_gen.sh
You are now ready to start |var_product_name|
You will be asked for the following information
#. First and last name
#. Name of organization unit
#. Name of organization
#. Name of City or Locality
#. Name of State or Province
#. Name of Country code
#. Finally when asked to "Enter key password for <aginity_cert> (RETURN if same as keystore password): " use the default password **changeit**
Starting Aginity Team Server
================================
**Step 7:** You are now ready to start |var_product_name|
We use the following commands to start |var_product_name| in the background and with logging turned on.
.. code-block:: bash
# switch to the aginity-team service account (housing the base team folder)
sudo su - svc_admin
cd aginity-team
# invoke the startup command
nohup ./bin/team-server-start.sh > ./team-logs.out 2>&1 &
# invoke the startup command with logging
cd /opt/aginityteam/bin
nohup bash team-server-start.sh > team-logs.out 2>&1 &
If you do not want logging turned on use the following commands
.. code-block:: bash
# switch to the aginity-team service account (housing the base team folder)
sudo su - svc_admin
cd aginity-team
# invoke the startup command
nohup ./bin/team-server-start.sh >/dev/null 2>&1 &
# invoke the startup command without logging
nohup bash team-server-start.sh >/dev/null 2>&1 &
You can check if |var_product_name| is running by issuing this command
.. code-block:: bash
sudo ps aux | grep aginity-team
Installing SSL certificate
==================================
* Before running Team app one should execute the following steps:
#. Using provided distribution generate ssl certificate using bin/ssl_certificate_gen.sh
#. Proceed with command line input as required
#. Leave default password for the keystore
ps aux | grep aginity-team
Accessing |var_product_name| for the First Time
=================================================
* Open a browser and navigate to https://<ip or team server name>:8080/app, you will be redirected to https://<ip or team server name>:8080/login. You will see the following image.
**Step 8:** Open a browser and navigate to https://<ip or team server name>:8080/app, you will be redirected to https://<ip or team server name>:8080/login. You will see the following image.
.. image:: ../../team_images/team_login_screen.png
:scale: 15
:scale: 40
:align: center
:alt: Opening Amp
* Enter credentials **admin** / **AginityTE@M** - You will be redirected to https://localhost:8080/app
* The admin user will then allow you to create other individual users.
**Step 9:** 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.
.. image:: ../../team_images/team_register.png
:scale: 40
:align: center
:alt: 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.
.. image:: ../../team_images/team_license_apply.png
:scale: 40
:align: center
:alt: Opening Amp
.. note::
......@@ -121,7 +196,6 @@ Stopping |var_product_name| Services
sudo pkill -f aginity-team
Once you open |var_product_name| you will commonly do these Actions.
.. seealso::
:ref:`Add Connections <newconn>`
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment