# Private Cloud HA

This section provides official documentation for deploying the **iMBrace platform in a Private Cloud environment**. Private Cloud deployments are designed for organisations that require **enhanced security, operational control, and scalable infrastructure** while running iMBrace within their own cloud boundary.

To support different operational needs, iMBrace offers **two Private Cloud deployment models**, each with dedicated documentation.

```
Private Cloud
├── Single Node – suitable for non-production or limited workloads
└── High Availability (HA) – designed for production-grade, resilient deployments
```

Each deployment model includes documentation covering:

* Infrastructure and system requirements
* Deployment procedures
* Environment-specific configuration
* Operational guidance and troubleshooting

### 1.  Private Cloud Single Node

The **Private Cloud Single Node** deployment model runs the entire iMBrace platform on a **single Linux server** within a private cloud environment. This model prioritises **simplicity and rapid deployment**.

#### Recommended For

* Evaluation and proof-of-concept deployments
* Internal testing environments
* Low-traffic or non-critical workloads

> ⚠️ **Important**\
> This deployment model does not provide redundancy or automatic failover and is not suitable for production workloads.

#### Included Documentation

1. &#x20;**Private Cloud Single Node Deployment Guide**

This document provides a comprehensive, step-by-step guide for deploying the iMBrace Private Cloud platform on a single-node Linux server.

{% file src="/files/s2lWq3DyaXGUdbo3mpKH" %}

**The guide covers:**

* Secure preparation of deployment artifacts
* System initialization and prerequisite validation
* Container image loading and verification
* Staged deployment of infrastructure and application services
* Post-deployment validation and health checks

This document is the **primary reference** for Private Cloud Single Node deployments.

> ⚠️ **Important**\
> This deployment model does not provide redundancy or automatic failover and is not recommended for production workloads.

### 2.  Private Cloud High Availability (HA)

The Private Cloud High Availability (HA) deployment model is designed for production environments that require resilience, scalability, and fault tolerance. This architecture distributes the iMBrace platform across multiple servers and managed services to eliminate single points of failure.

#### Recommended For

* Production and customer-facing environments
* High-traffic workloads
* Mission-critical deployments

#### Included Documentation

1. &#x20;**Private Cloud HA Specification**

{% file src="/files/IeOWElW8cNKrsJ0BibNr" %}

This document defines the technical and architectural requirements for deploying the iMBrace platform in a Private Cloud High Availability (HA) environment hosted on AWS. It serves as the authoritative reference for validating infrastructure readiness prior to any provisioning or deployment activities.

**This document includes:**

* Required infrastructure components, including:
  * Compute (EC2)
  * Datastores (MongoDB, PostgreSQL, Redis)
  * Streaming and messaging services (MSK)
* Supported server operating systems and system-level dependencies
* Networking architecture and firewall rules
* Platform service dependencies and inter-service communication requirements
* AWS-specific configuration requirements, including AWS Bedrock where applicable

**This document should be reviewed first** to ensure the target environment meets all prerequisites for a successful HA deployment.

2. **Private Cloud HA Infrastructure Configuration and Provision Guide**

This document provides detailed guidance for provisioning and configuring the AWS infrastructure required to support a Private Cloud HA deployment of the iMBrace platform. It establishes the foundational cloud environment on which the application will be deployed.

{% file src="/files/W3zYUK1KKXeXxuxfqULq" %}

**T**his guide covers configuration and setup of:

* DNS and SSL certificates
* Network segmentation and security group rules
* EC2 instances and compute layout
* Application Load Balancers (ALB) and Network Load Balancers (NLB)
* Identity and Access Management (IAM) roles and permissions
* Storage, database, caching, and messaging services, including:
  * S3
  * RDS
  * ElastiCache
  * MSK

This document should be used after reviewing the HA Specification and before executing any application deployment steps.

3. **Private Cloud ALB and NLB Configuration**

This is a **supplementary reference document** that expands on the load balancer configuration defined in the Infrastructure Configuration and Provision Guide.

It provides detailed technical specifications for the **Public Application Load Balancer (ALB)** and **Network Load Balancer (NLB)** used in the HA architecture.

{% file src="/files/rnIrZy01VpEioNXTHTRX" %}

**This document includes:**

* ALB target group definitions
* Health check configurations and thresholds
* Target groups for platform services such as:
  * `app-gateway`
  * `backend`
* Port and protocol mappings
* Registered target servers (for example, `onserver-1` and `onserver-2`)

This document should be referenced during **load balancer setup, validation, and troubleshooting**.

4. **Private Cloud HA Deployment Guide**

This document is the primary deployment guide for installing and configuring the iMBrace platform in a Private Cloud High Availability environment. It provides a comprehensive, step-by-step deployment process, covering the transition from a provisioned infrastructure to a fully operational platform.

{% file src="/files/Fq09kaHGcsXyXefifukD" %}

**This guide covers:**

* Deployment prerequisites and readiness checks
* Local machine preparation
* Server and system configuration using Ansible
* Application deployment and configuration updates
* Verification, validation, and post-deployment checks

This document should be followed **after infrastructure provisioning is complete** and serves as the main reference during the deployment process.

5. **Private Cloud HA Deployment Environment Variables**

This document is a supplementary configuration guide that supports the HA Deployment Guide. It defines all environment-specific variables that must be customised for each customer deployment to ensure correct platform behaviour.

{% file src="/files/XOd9KgSg3tsxPUVSWu6A" %}

**This document includes configuration values for:**

* API keys and secrets
* Database connection strings
* Service endpoints
* Application-specific configuration parameters

All values in this document must be **reviewed and updated** to match the target environment prior to deployment.

6. **Private Cloud HA FAQ**

This document provides **operational guidance and troubleshooting support** for Private Cloud HA deployments. It is intended for use during **post-deployment operations, monitoring, and support** activities.&#x20;

{% file src="/files/mGsVb4Yc4waVEyjetmqU" %}

**This document covers:**

* Mapping platform services and containers (e.g., `backend`, `ai-service`, `ips`) to their respective host servers
* Identifying running containers
* Step-by-step instructions for accessing logs
* Common diagnostic Docker commands, including:
  * `docker ps`
  * `docker inspect`
  * `docker logs`

This document serves as a **practical reference** for operations and support teams when investigating issues or validating platform behaviour.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://imbrace.gitbook.io/imbrace-documentation/infrastructure/private-cloud-ha.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
