Cloud Portal ONE Desktop ONE DQ&C ONE MDM ONE RDM ONE Runtime Server
latest (16.2.0) 16.1.0 16.0.0 15.4.0 15.3.0 15.2.0 15.1.0 14.5.x 13.9.x 13.8.x 13.7.x 13.6.x 13.5.0 13.4.x 13.3.x 13.2.x
User Community Service Desk Downloads

Self-Managed Deployment Guide

Introduction

The automated installation is performed by Ansible, a tool for automated server installation and configuration. A package containing the Ansible playbooks that describe all the steps required for installing Ataccama ONE is provided for each release.

A successful installation requires the following:

  • Command line (SSH) access to all customer servers where Ataccama ONE is installed.

  • Ansible package containing the necessary playbooks (and their accessories).

  • Ansible inventory, that is, files describing customer-specific parts of the process (such as server names, optional component presence).

  • Installed and configured Ansible software.

Once everything is prepared, you can run Ansible. Ansible installs and configures all the components, resulting in a working system.

Detailed information about how to run Ansible can be found in the Ansible package docs directory (ansible-<version>.zip).

ansible-<version>.zip/docs
ansible-<version>.zip/docs/
drw-rw-rw-  3 admin 0     0 2021-09-03 10:31 assets
-rw-rw-rw-  1 admin 0  5770 2021-09-03 07:53 installing_ansible.md
-rw-rw-rw-  1 admin 0 15479 2021-09-03 07:53 inventory.md
-rw-rw-rw-  1 admin 0  9649 2021-09-03 07:53 inventory_examples.md
-rw-rw-rw-  1 admin 0   842 2021-09-03 07:53 README.md
-rw-rw-rw-  1 admin 0  2317 2021-09-03 07:53 running_ansible.md
-rw-rw-rw-  1 admin 0  2622 2021-09-03 07:53 tat.md

Required knowledge

This guide expects at least basic familiarity with Linux OS. You are expected to know how to:

  • Run commands using the command line (BASH).

  • Change directories.

  • Edit text files.

  • Connect to a server through SSH using password or public key authentication.

Glossary

Ansible

An open source software used for automated software deployment.

Ansible controller

A computer that runs Ansible. The controller connects to the target servers, runs every command required, and displays results.

Ansible inventory

A part of Ansible configuration that describes what target servers are and their roles (that is, which software will be installed where), as well as all parameters that control the specifics of the installation. It is stored as directories and files inside a single directory.

Ansible package

Playbooks, roles, and documentation developed by the platform delivery team, describing the automated installation process. The package does not contain the inventory or the Ansible software itself.

Prerequisites

Make sure your setup conforms to the Deployment Preconditions before proceeding with the installation.

Download the installation package

The Ansible package is a ZIP archive (ansible-<version>.zip) containing code for installing the platform. For more details about how to install Ansible and how to prepare for installation, see the docs folder within the package.

Download the Ansible package from the Downloads page. This archive should be placed on the Ansible controller.

Unpack the Ansible archive using the following commands:

Extract Ansible package
$ mkdir -p ~/one
$ wget <download_URL>/ansible-<version>.zip
$ unzip ansible-<version>.zip -d ~/one

The documentation about how to work with Ansible is now available in the ~/one/docs directory.

Choose the solution components and installation sizing

It is possible to deploy the system to any number of servers, with three reference deployment sizes available.

We support the following solution components.

Solution components

  • ONE standalone

    Click to view the deployment schema
    image

  • ONE with DQIT

    Click to view the deployment schema
    image

  • Complete solution

    Click to view the deployment schema
    image

Installation

For more details, see the Ansible package, section Installation & requirements in docs/installing_ansible.md.

Ansible inventory

For information about how to prepare the Ansible inventory, see the Ansible package, section Ansible inventory in docs/inventory.md.

Ansible software

For information about how to install Ansible on the Ansible controller, see the Ansible package, section Installation & requirements in docs/installing_ansible.md.

Run Ansible

For information about how to run Ansible, see the Ansible package, section Running Ansible in docs/running_ansible.md.

Post-installation checks

Use the monitoring stack for installation process check

One of the first components that is installed using Ansible is the Observability Stack. This stack provides an overview of the health status of particular platform components.

To access particular monitoring tools, the following applications are deployed:

  • Prometheus: The main monitoring component. Provides an overview about particular components.

    Available at https://monitoring._domain_name.

  • Grafana: Graphical monitoring and metrics visualization.

    Available at https://grafana._domain_name.

  • Kibana: Log messages management.

    Available at https://kibana._domain_name.

Prometheus

The provided UI for Prometheus can display details about components, as well as some basic information about the health and installation state. If you access https://one.<domain_name>/targets,` you can see a list of the monitored endpoints and applications.

Every running application should have its name shown in blue. During the installation, components change thei color from red (not working) to blue (deployed and passed the basic health check). This check means that the application is running.

Ansible log file

Depending on the Ansible setup, detailed information about the installation (Ansible output) is recorded in the Ansible log file. This file contains the history of all triggered Ansible playbook runs.

You can find it in .ansible directory in your home directory:

Ansible log file
user@computer:~$ pwd
/home/user
user@USER:~$ ls -l .ansible/ansible.log
-rw-rw-r-- 1 user usergroup 1566413 srp 27 11:02 .ansible/ansible.log

Check running components based on hostnames

Depending on which components you selected for installation, new web addresses are available for the end users.

Web applications
Third-party components
Desktop endpoint
Observability

Was this page useful?