Install Platform

Installing Platform involves several components, external dependencies, and a specific installation order. This overview covers what each piece is, why it’s needed, and how they fit together. For step-by-step installation instructions, see the Itential Deployer documentation.

What you’ll install

A Platform deployment consists of the following core components. Each component is described briefly here; the Deployer documentation covers how to configure each one.

ComponentDescriptionRequired
Operating System PackagesFoundational software required on every host before anything else can be installed. For example, openssl.Yes
MongoDBPrimary database for storing Platform configuration and operational data.Yes
RedisIn-memory data store for caching and coordinating activity across Platform nodes.Yes
Itential Automation Gateway (IAG)Optional edge execution agent that runs separately from Platform and extends its reach into target environments.No

System requirements and dependencies

Before you install, verify that your infrastructure meets the supported operating system, hardware, and software dependency requirements. For the full list, see System requirements and dependencies.

Deployment architectures

Platform supports several deployment architectures depending on your environment and availability requirements. Choose an architecture before you run the Deployer.

For a complete overview of all available deployment models and architectures, see Deployment architecture overview.

High availability

A highly available architecture (HA2) is an Itential architecture where all components are redundant and can gracefully tolerate at least one catastrophic failure. It’s the recommended architecture for production and testing environments.

For more information, see High availability architecture.

Active/standby architecture

An active/standby architecture (ASA) is an Itential architecture where all components are redundant and can gracefully tolerate at least one catastrophic failure while providing redundancy for the primary data center.

For more information, see Active/standby architecture.

Minimal

A development architecture (minimal architecture) provides a validated design for development and testing environments.

For more information, see Minimal architecture.

Installation order

The Deployer automatically handles installation sequencing. This section explains the logical order so you understand why the sequence matters and can troubleshoot if something goes wrong.

1

Prepare host

Before installing any Itential software, bring every host to a known baseline state. Complete the following tasks on each host:

  • Install required OS-level packages and CA certificates.
  • Create a dedicated user account for running Itential software.
  • Configure firewall rules to allow communication between components.

Steps vary by component.

2

Install Redis

In a highly available topology, designate one node as primary and configure the remaining nodes as replicas. Run a Sentinel process alongside Redis on each host. Sentinels monitor each other and the primary node, and automatically elect a new primary if the current one becomes unreachable.

3

Install MongoDB

In a highly available topology, join the MongoDB nodes into a replica set to synchronize data across all nodes. Then configure access credentials to restrict connections to authorized components only.

4

Install Itential Platform

Install the specific versions of Node.js and Python that Platform requires. Then install the core Platform package and any required adapters. Configure the MongoDB and Redis connections, add any TLS certificates, and integrate with Secrets Manager if applicable.

Platform requires a healthy MongoDB and Redis instance to start. Complete the MongoDB and Redis steps before this one.

5

Install Itential Gateway

Install Automation Gateway on dedicated hosts using the RPM, independently of Platform. Then apply TLS certificates and configure the Gateway Manager application in Platform.

Before you begin

Confirm the following before you run the Deployer:

  • All required dependencies are installed and reachable
  • OS and hardware requirements are met on all target nodes
  • Required ports are open
  • You have the required credentials or service accounts
  • You have chosen a deployment architecture
  • You have reviewed the Deployer release notes for the version you are installing

What’s next