Atria v15 Clean Installation

Atria v15 Clean Installation

Overview

This article outlines the clean install process for the Atria Platform.  

System Requirements

In order to install Atria v15 you MUST complete the prerequisite components noted in the following article: https://support.automate101.com/portal/en/kb/articles/atria-v15-system-requirements

Atria v15 Clean Installation Check List

Here is a check list summary to ensure the environment is ready for install:
StepItem DescriptionNotes
1.1
.Net Framework 4.8
This applies to all servers
1.2PowerShell 5.1This applies to all servers
1.3Servers are Domain joinedThis applies to all servers
1.4
Active Directory Schema has been extended
AD Server - To get more information on how to extend AD please refer to Prepare Active Directory and domains for Exchange Server, Active Directory Exchange Server, Exchange Server Active Directory, Exchange 2019 Active Directory | Microsoft Docs
1.5
Install Erlang and RabbitMQ
Please refer to https://support.automate101.com/portal/en/kb/articles/atria-v15-system-requirements for a step by step configuration.
1.6Configure RabbitMQ and add messaging DNS entryPlease refer to https://support.automate101.com/portal/en/kb/articles/atria-v15-system-requirements for a step by step configuration.
1.7
Atria network ports are open and accessibleTo get more information please refer to https://support.automate101.com/portal/en/kb/articles/atria-v15-system-requirements
1.8
SQL Server is running and accessible from Provisioning serverThis applies to SQL Server

Atria Installation Summary at a glance

The following table summarises the steps in the install process
StepItem DescriptionNotes
1Installation Check list
2
Install Atria.Tools.Setup-Bootstrap
    This needs to be installed on all servers and provides access to Atria tools module.
    3Install Atria Tools ModuleThis needs to be installed on all servers and provides access to Atria installer commands.
    4
    Deploy Components (Provisioning Server)
       - Config Service Component
       - Register Atria Environment
       - Database Component
       - Atria Agent Component
       - Platform API Component
       - Provisioning Component
       - Provisioning Manager Component
       - DirectoryWS Component
    - Refer to https://support.automate101.com/portal/en/kb/articles/config-service-installation-options to get more information about Config Service Component
    - Database Component installs Atria databases (OLM and OLM Reporting) on SQL server
    - Atria Agent Component is responsible to install required services to communicate between environments
    - Platform API Component includes all APIs used within Atria environment
    - Provisioning Component will deploy provisioning service and required files
    - Provisioning Manager provides UI to access and view provisioning rules, events and actions
    - Directory Component installs all required files to communicate with Active Directory

    5Transfer Certificates from Provisioning server to Web serverRefer to Transfer Certificates for a step by step walkthrough
    6
    Deploy Components (Web Server)
       - Web Server Components
    - This applies to Web Server
    7Post Installation ProcessRefer to Remote Environment Configuration

    Installation Guide

    Once the prerequisites are met, you can run the following commands in PowerShell to start installing Atria components.
    Run commands using PowerShell (Administrator Mode)
    Install Atria.Tools.Setup-Bootstrap from Powershell Gallery 
    1. [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
    2. Install-Script Atria.Tools.Setup-Bootstrap

    Update the Atria.Tools.Setup-Bootstrap Script to point to Public Beta Feed (Early Adopters)

    1. notepad 'C:\Program Files\WindowsPowerShell\Scripts\Atria.Tools.Setup-Bootstrap.ps1'
    2. Update the $RepositoryLocation value
      $RepositoryLocation = 'https://pkgs.dev.azure.com/Automate101/A101/_packaging/Atria-Beta@PublicBeta/nuget/v2'

    Install Atria.Tools module from the script

    1. Atria.Tools.Setup-Bootstrap.ps1 -username 'any username' -PersonalAccessToken 'access token provided by Automate101'
    This will install 2 Atria modules: Atria.Tools and Atria.Platform

    Repeat these steps to each server that you will run the Atria package installers. For the database, you can run the install on the provisioning server since we will pass database server parameters when running the command to install.

    Provisioning Server

    Config Service Component

    The Config Service centrally stores configuration and secrets and is used by all Atria components.
    By default, you can use the following command to install the config service database.

    The Install-AtriaConfigService cmdlet installs the Atria Config Service. 
    This installer will create a database called AtriaConfigService on the database server specified, ensure this is added to your backup routines.
    Ensure all highlighted parameters are completed.
    Below example uses -UseSQLStore parameter, to get detailed information about Config Service please refer to: https://support.automate101.com/portal/en/kb/articles/config-service-installation-options
     
    Credential : a domain admin credential that will be used to run the installers
    StorageConnectionString : database server\instance and port
    MessagingUrl : RabbitMQ Messaging Alias
    MessagingUsername : RabbitMQ Admin Account Username
    Messaging Password : RabbitMQ Admin Account Password
    Storage Type : -UseSQLStore / -UseFileSystemStore  / -UseKeyVaultStore 
    1. Install-AtriaConfigService -Credential (Get-Credential) -StorageConnectionString 'Server=AtriaSQL\Instance;Database=AtriaConfigService;Trusted_Connection=True' -MessagingUrl ''amqps://rabbitmq messaging alias' -MessagingUsername ''rabbitmq admin account username' -MessagingPassword ''rabbitmq admin account password'' -UseSQLStore

    Register Atria Environment

    Before Installing/Updating the main Atria Database

    Requirement for Registering  Atria (details for each parameter set)
          Environment : 'Staging' or 'Production'
          CRMId : CRM Deployment Id - to be provided by Automate101 Support
          Customer : Customer Name

    1. Set-AtriaRegistrationDetails -Environment Staging -CRMId 'CRMID' -Customer 'Customer Name' 

    Database Component

    Before installing database component please make sure that your database server is running and accessible via provisioning server. You can use the following sample command to check the connectivity:
    1. Test-NetConnection -ComputerName 'AtriaSQL' -Port 1433
    1. Install-AtriaDatabase -ServerInstance 'ATRIASQL\instance' -ServerPort 'sqlport-UseWindowsAuth
    Instance is optional depending on SQL Server setup.
    Make sure that the account has sysadmin role into the database.
    You can use -SQLCredential as an alternative for -UseWindowsAuth.

    Atria Agent Component

    1. Install-AtriaAgent

    PlatformAPI Component

    1. Install-AtriaPlatformApi

    Provisioning Component

    1. Install-AtriaProvisioning
    In Atria v15, provisioning engine is been separated from the provisioning manager UI. 

    Provisioning Manager Component

    1. Install-AtriaProvisioningManager

    Directory Web Service Component

    1. Install-AtriaDirectory


    Web Server

    Before running the commands in next step to install Atria web components,  transfer certificates from Provisioning server to your Web server. 
    Follow the steps on Transfer certification to ensure the Web Server is ready for installation.

    Web Component

    The Atria Web component includes 4 different components - you can install all of them by using the following command:
    1. Install-AtriaWebComponents
    Or install each component individually with:
    1. Install-AtriaWebForms
    2. Install-AtriaProxy
    3. Install-AtriaWeb
    4. Install-AtriaExternalAPI

    Post Installation

    Once you have completed the installation it is always important to test, navigate to https://atriaweb/ and ensure the environment is accessible and running.

    Remote Environment Configuration

    Remote environments feature in Atria v15 enables customers to be managed in both shared and private Active Directory networks.  This article gives you more information on different environment types and associated features:  Remote Environment Configuration.

      • Related Articles

      • Atria v12.11+ System Requirements

        Overview  The following article provides the prerequisites necessary for the deployment of Atria v12.11+ into your environment.  System Requirements   Environment  Core servers for the platform should be domain joined. Before you can deploy Atria ...
      • Atria Billing Setup User Guide

        Objective This article describes how to configure Atria to utilize the latest billing features. This document outlines the billing setup attributes that should be configured.    Applies to Introduced in Atria version 12.0.0 Billing Setup Overview To ...
      • Atria v12.11+ Deployment Guide

        Overview  This article outlines the deployment procedure of Atria v12.11+.  This article will also refer to other articles that may assist with your installation or upgrade. Alert:  In-place migration from any version of CloudPortal Services Manager ...
      • Adding a Remote Dedicated Customer

        Overview In Atria V15, we now have the ability to manage Private Active Directory's. Customers who have their own AD Infrastructure, gain the same self service and management capabilities of Atria that have worked so well for multi-tenant Active ...
      • Atria v15+ System Requirements

        Overview  The following article provides the prerequisites necessary for the deployment of Atria v15+ into your environment.    System Requirements   Environment  Core servers for the platform should be domain joined. Before you can deploy Atria ...